cellxgene_census.experimental.get_embedding_metadata_by_name

cellxgene_census.experimental.get_embedding_metadata_by_name(embedding_name: str, organism: str, census_version: str, embedding_type: str | None = 'obs_embedding') → dict[str, Any]

Return metadata for a specific embedding. If more embeddings match the query parameters, the most recent one will be returned.

Parameters:

• embedding_name – The name of the embedding, e.g. “scvi”.

• organism – The organism for which the embedding is associated.

• census_version – The Census version tag, e.g., "2023-12-15".

• embedding_type – Either “obs_embedding” or “var_embedding”. Defaults to “obs_embedding”.

Returns:

A dictionary containing metadata describing the embedding.

Raises:

ValueError – if no embeddings are found for the specified query parameters.