diff --git a/_autosummary/cellxgene_census.download_source_h5ad.html b/_autosummary/cellxgene_census.download_source_h5ad.html index 9b6b70c7b..0fe56194c 100644 --- a/_autosummary/cellxgene_census.download_source_h5ad.html +++ b/_autosummary/cellxgene_census.download_source_h5ad.html @@ -123,13 +123,6 @@ - - -
Download the source H5AD dataset, for the given dataset_id, to the user-specified file name.
ValueError – if the path already exists (i.e., will not overwrite an existing file), or is not a file.
+ValueError – if the path already exists (i.e., will not overwrite an existing file), or is not a file.
Lifecycle
diff --git a/_autosummary/cellxgene_census.experimental.get_all_available_embeddings.html b/_autosummary/cellxgene_census.experimental.get_all_available_embeddings.html index 3b55ee915..2f0fef1c1 100644 --- a/_autosummary/cellxgene_census.experimental.get_all_available_embeddings.html +++ b/_autosummary/cellxgene_census.experimental.get_all_available_embeddings.html @@ -123,13 +123,6 @@ - - -Return a dictionary of all available embeddings for a given Census version.
Get a list of all census versions that contain a specific embedding.
Read cell (obs) embeddings and return as a dense numpy.ndarray
. Any cells without
an embedding will return NaN values.
numpy.ndarray
.
ValueError – if the Census and embedding are mismatched.
+ValueError – if the Census and embedding are mismatched.
Lifecycle
diff --git a/_autosummary/cellxgene_census.experimental.get_embedding_metadata.html b/_autosummary/cellxgene_census.experimental.get_embedding_metadata.html index 05eebac2e..8fc9311d0 100644 --- a/_autosummary/cellxgene_census.experimental.get_embedding_metadata.html +++ b/_autosummary/cellxgene_census.experimental.get_embedding_metadata.html @@ -123,13 +123,6 @@ - - -Read embedding metadata and return as a Python dict.
Return metadata for a specific embedding. If more embeddings match the query parameters, the most recent one will be returned.
A dictionary containing metadata describing the embedding.
ValueError – if no embeddings are found for the specified query parameters.
+ValueError – if no embeddings are found for the specified query parameters.
An encoder that concatenates and encodes several obs
columns.
Methods
diff --git a/_autosummary/cellxgene_census.experimental.ml.encoders.Encoder.html b/_autosummary/cellxgene_census.experimental.ml.encoders.Encoder.html index faae340fa..2ea90d59f 100644 --- a/_autosummary/cellxgene_census.experimental.ml.encoders.Encoder.html +++ b/_autosummary/cellxgene_census.experimental.ml.encoders.Encoder.html @@ -123,13 +123,6 @@ - - -Default encoder based on sklearn.preprocessing.LabelEncoder
.
Methods
diff --git a/_autosummary/cellxgene_census.experimental.ml.huggingface.CellDatasetBuilder.html b/_autosummary/cellxgene_census.experimental.ml.huggingface.CellDatasetBuilder.html index bd6f355c9..f141c4eeb 100644 --- a/_autosummary/cellxgene_census.experimental.ml.huggingface.CellDatasetBuilder.html +++ b/_autosummary/cellxgene_census.experimental.ml.huggingface.CellDatasetBuilder.html @@ -123,13 +123,6 @@ - - -Abstract base class for methods to process CELLxGENE Census ExperimentAxisQuery results into a Hugging Face Dataset in which each item represents one cell. Subclasses implement the cell_item() method to process each row of an X layer @@ -252,7 +245,7 @@
Initialize the CellDatasetBuilder to process the results of a Census ExperimentAxisQuery.
Generate a Hugging Face Dataset containing Geneformer token sequences for each cell in CELLxGENE Census ExperimentAxisQuery results (human).
This class requires the Geneformer package to be installed separately with: @@ -261,7 +254,7 @@
Initialize GeneformerTokenizer.
Args: - experiment: Census Experiment to query diff --git a/_autosummary/cellxgene_census.experimental.ml.pytorch.ExperimentDataPipe.html b/_autosummary/cellxgene_census.experimental.ml.pytorch.ExperimentDataPipe.html index a9512a15b..0579b7125 100644 --- a/_autosummary/cellxgene_census.experimental.ml.pytorch.ExperimentDataPipe.html +++ b/_autosummary/cellxgene_census.experimental.ml.pytorch.ExperimentDataPipe.html @@ -123,13 +123,6 @@ - - -
An torchdata.datapipes.iter.IterDataPipe
that reads obs
and X
data from a
tiledbsoma.Experiment
, based upon the specified queries along the obs
and var
axes. Provides an
iterator over these data when the object is passed to Python’s built-in iter
function.
Construct a new ExperimentDataPipe
.
Statistics about the data retrieved by ExperimentDataPipe
via SOMA API. This is useful for assessing the read
throughput of SOMA data.
Lifecycle
experimental
Method generated by attrs for class Stats.
Factory method for torch.utils.data.DataLoader
. This method can be used to safely instantiate a
torch.utils.data.DataLoader
that works with cellxgene_census.experimental.ml.pytorch.ExperimentDataPipe
,
since some of the torch.utils.data.DataLoader
constructor parameters are not applicable when using a
@@ -250,7 +243,7 @@
ValueError – if any of the shuffle
, batch_size
, sampler
, batch_sampler
, or collate_fn
params
+
ValueError – if any of the shuffle
, batch_size
, sampler
, batch_sampler
, or collate_fn
params
are passed as keyword arguments.
Convience wrapper around tiledbsoma.Experiment
query and
cellxgene_census.experimental.pp.highly_variable_genes()
function, to build and execute a query, and annotate
the query result genes (var
dataframe) based upon variability.
pandas.DataFrame
containing annotations for all var
values specified by the query.
ValueError – if the flavor paramater is not "seurat_v3"
.
ValueError – if the flavor paramater is not "seurat_v3"
.
Identify and annotate highly variable genes contained in the query results. The API is modelled on ScanPy scanpy.pp.highly_variable_genes API. Results returned will mimic ScanPy results. The only flavor available @@ -254,7 +247,7 @@
scanpy.pp.highly_variable_genes()
.
ValueError – if the flavor parameter is not "seurat_v3"
.
ValueError – if the flavor parameter is not "seurat_v3"
.
Examples
diff --git a/_autosummary/cellxgene_census.experimental.pp.mean_variance.html b/_autosummary/cellxgene_census.experimental.pp.mean_variance.html index c2dfa21f3..a1b1b9e6e 100644 --- a/_autosummary/cellxgene_census.experimental.pp.mean_variance.html +++ b/_autosummary/cellxgene_census.experimental.pp.mean_variance.html @@ -123,13 +123,6 @@ - - -Calculate mean and/or variance along the obs
axis from query results. Calculations are done in an accumulative
chunked fashion. For the mean and variance calculations, the total number of elements (N) is, by default, the
corresponding dimension size: for column-wise calculations (axis = 0
) N is number of rows, for row-wise
diff --git a/_autosummary/cellxgene_census.get_anndata.html b/_autosummary/cellxgene_census.get_anndata.html
index 357956037..2b446e9c8 100644
--- a/_autosummary/cellxgene_census.get_anndata.html
+++ b/_autosummary/cellxgene_census.get_anndata.html
@@ -123,13 +123,6 @@
-
-
-
Convenience wrapper around tiledbsoma.Experiment
query, to build and execute a query,
and return it as an anndata.AnnData
object.
Get release description for given Census version, from the Census release directory.
CensusVersionDescription
- a dictionary containing a description of the release.
ValueError – if unknown census_version
value.
ValueError – if unknown census_version
value.
Lifecycle
diff --git a/_autosummary/cellxgene_census.get_census_version_directory.html b/_autosummary/cellxgene_census.get_census_version_directory.html index cd36f6708..89aa9cb66 100644 --- a/_autosummary/cellxgene_census.get_census_version_directory.html +++ b/_autosummary/cellxgene_census.get_census_version_directory.html @@ -123,13 +123,6 @@ - - -Get the directory of Census versions currently available, optionally filtering by specified flags. If a filtering flag is not specified, Census versions will not be filtered by that flag. Defaults to including both “long-term stable” (LTS) and weekly Census versions, and excluding diff --git a/_autosummary/cellxgene_census.get_default_soma_context.html b/_autosummary/cellxgene_census.get_default_soma_context.html index 1210790a2..7d8d24912 100644 --- a/_autosummary/cellxgene_census.get_default_soma_context.html +++ b/_autosummary/cellxgene_census.get_default_soma_context.html @@ -123,13 +123,6 @@ - - -
Return a tiledbsoma.SOMATileDBContext
with sensible defaults that can be further customized by the
user. The customized context can then be passed to cellxgene_census.open_soma()
with the context
argument or to somacore.SOMAObject.open()
with the context
argument, such as
diff --git a/_autosummary/cellxgene_census.get_obs.html b/_autosummary/cellxgene_census.get_obs.html
index c795a946b..dfadb5dc9 100644
--- a/_autosummary/cellxgene_census.get_obs.html
+++ b/_autosummary/cellxgene_census.get_obs.html
@@ -123,13 +123,6 @@
-
-
-
Get the observation metadata for a query on the census.
Read the feature dataset presence matrix and return as a scipy.sparse.csr_array
. The
returned sparse matrix is indexed on the first dimension by the dataset soma_joinid
values,
and on the second dimension by the var
pandas.DataFrame
soma_joinid
values.
A scipy.sparse.csr_array
object containing the presence matrix.
ValueError – if the organism cannot be found.
+ValueError – if the organism cannot be found.
Lifecycle
diff --git a/_autosummary/cellxgene_census.get_source_h5ad_uri.html b/_autosummary/cellxgene_census.get_source_h5ad_uri.html index f8e25772c..7467af360 100644 --- a/_autosummary/cellxgene_census.get_source_h5ad_uri.html +++ b/_autosummary/cellxgene_census.get_source_h5ad_uri.html @@ -123,13 +123,6 @@ - - -Open the named version of the census, and return the URI for the dataset_id
. This
does not guarantee that the H5AD exists or is accessible to the user.
KeyError – if either dataset_id
or census_version
do not exist.
KeyError – if either dataset_id
or census_version
do not exist.
Lifecycle
diff --git a/_autosummary/cellxgene_census.get_var.html b/_autosummary/cellxgene_census.get_var.html index 00322d525..b457b9377 100644 --- a/_autosummary/cellxgene_census.get_var.html +++ b/_autosummary/cellxgene_census.get_var.html @@ -123,13 +123,6 @@ - - -Get the variable metadata for a query on the census.
Open the Census by version or URI.
ValueError – if the census cannot be found, the URI cannot be opened, neither a URI +
ValueError – if the census cannot be found, the URI cannot be opened, neither a URI or a version are specified, or an invalid mirror is provided.