Missing documentation for vector_field_function

[Baschdl]

I would like to use the function f(x) like you describe it in the "10min to dynamo" tutorial [1] to get the velocity for unseen gene expression vectors x. Unfortunately, the dynamo.vf.vector_field_function (which I guess is f) is missing it's documentation on readthedocs [2] despite having a docstring: https://github.com/aristoteleo/dynamo-release/blob/e87f702da0eb2ff2aa28e861dd7993c0b50e3fbe/dynamo/vectorfield/utils.py#L73-L96

I tried running it according to this documentation but it's unclear to me what vf_dict is. Probably something generated from dyn.vf.VectorField:

|-----> <insert> velocity_S_SparseVFC to layers in AnnData Object.
|-----> <insert> VecFld to uns in AnnData Object.
|-----> <insert> control_point to obs in AnnData Object.
|-----> <insert> inlier_prob to obs in AnnData Object.
|-----> <insert> obs_vf_angle to obs in AnnData Object.

[1] https://dynamo-release.readthedocs.io/en/latest/ten_minutes_to_dynamo.html#vector-field-reconstruction [2] https://dynamo-release.readthedocs.io/en/latest/_autosummary/dynamo.vf.vector_field_function.html

[Sichao25]

Thanks for reporting the issue. Your guess is correct, dynamo.vf.vector_field_function is the vector field function. The docstring has not been generated correctly. I will add it soon. Actually, we have a helper function to retrieve the vector field. You may be able to call it like vf_dict, f = dynamo.vf.utils.vecfld_from_adata(adata, basis='umap'). Let me know if this helps.

[Baschdl]

Thanks a lot for your help. vf_dict, f = dyn.vf.utils.vecfld_from_adata(adata, basis='umap') currently fails with ValueError: Vector field function VecFld_umap is not included in the adata object! Try firstly running dyn.vf.VectorField(adata, basis='umap').

The output of dyn.vf.VectorField says that everything worked correctly

dyn.vf.VectorField(adata[:,adata.var.use_for_transition], velocity_key="velocity_S", layer="spliced", basis='umap')

|-----> VectorField reconstruction begins...
|-----> Retrieve X and V based on basis: UMAP. 
        Vector field will be learned in the UMAP space.
|-----> Generating high dimensional grids and convert into a row matrix.
|-----> Learning vector field with method: sparsevfc.
|-----> [SparseVFC] begins...
|-----> Sampling control points based on data velocity magnitude...
|-----> [SparseVFC] in progress: 100.0000%
|-----> [SparseVFC] finished [10.4133s]
|-----> <insert> velocity_umap_SparseVFC to obsm in AnnData Object.
|-----> <insert> X_umap_SparseVFC to obsm in AnnData Object.
|-----> <insert> VecFld_umap to uns in AnnData Object.
|-----> <insert> control_point_umap to obs in AnnData Object.
|-----> <insert> inlier_prob_umap to obs in AnnData Object.
|-----> <insert> obs_vf_angle_umap to obs in AnnData Object.
|-----> [VectorField] in progress: 100.0000%
|-----> [VectorField] finished [10.6760s]

but the inserts do not end up in adata, e.g. X_umap_SparseVFC should be in obsm but my adata looks like this: obsm: 'X_pca', 'X_umap', 'velocity_umap', 'X'.

[Sichao25]

VectorField will automatically store the result to the given AnnData, but I feel like this might not work when given a view like adata[:,adata.var.use_for_transition]. Could you try to set the copy to True and set it back to the adata like:

adata = dyn.vf.VectorField(adata[:, adata.var.use_for_transition], basis='umap', copy=True)
vecfld_dict, vecfld = dyn.vf.utils.vecfld_from_adata(adata, basis='umap')

Let me know if this helps you.

[Baschdl]

Great this works now. The view is also not needed anymore once PR https://github.com/aristoteleo/dynamo-release/pull/619 is merged.

Is there any way of learning the vector field for all original genes and not only the once in adata.var.use_for_transition? I tried to select all genes as transition genes but this doesn't work currently, see PR https://github.com/aristoteleo/dynamo-release/pull/638.

[Sichao25]

You may be able to do that by setting transition_genes=adata.var_names. Index is preferred instead of boolean value.

[github-actions[bot]]

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days