dynamo.sim.evaluate¶
- dynamo.sim.evaluate(reference, prediction, metric='cosine')[source]¶
Function to evaluate the vector field related reference quantities vs. that from vector field prediction.
- Parameters:
reference (
ndarray) – The reference quantity of the vector field (for example, simulated velocity vectors at each point or trajectory, or estimated RNA velocity vector).prediction (
ndarray) – The predicted quantity of the vector field (for example, velocity vectors calculated based on reconstructed vector field function at each point or trajectory, or reconstructed RNA velocity vector).metric (
str(default:'cosine')) – The metric for benchmarking the vector field quantities after reconstruction.
- Returns:
The score between the reference vs. reconstructed quantities based on the metric.
- Return type:
res