anndata.io.read_h5ad

目录

anndata.io.read_h5ad#

anndata.io.read_h5ad(filename, backed=None, *, as_sparse=(), as_sparse_fmt=<class 'scipy.sparse._csr.csr_matrix'>, chunk_size=6000)[source]#

读取 .h5ad 格式的 hdf5 文件。

Parameters:
filename str | Path

数据文件的文件名。

backed Union[Literal['r', 'r+'], bool, None] (default: None)

如果 'r',以 AnnDatabacked 模式加载,而不是完全加载到内存中(memory 模式)。如果您想修改 AnnData 对象的 backed 属性,您需要选择 'r+'

目前,backed 仅支持对 X 的更新。这意味着对其他槽(如 obs)的任何更改将不会在 backed 模式下写入磁盘。如果您想保存对 backed AnnData 的这些槽所做的更改,请将它们写入新文件(请参见 write())。有关示例,请参见 [here] (https://anndata-tutorials.readthedocs.io/en/latest/getting-started.html#Partial-reading-of-large-data)。

as_sparse Sequence[str] (default: ())

如果一个数组被保存为稠密的,这里传递它的名称将按块大小 chunk_size 作为稀疏矩阵读取它。

as_sparse_fmt type[spmatrix] (default: <class 'scipy.sparse._csr.csr_matrix'>)

稀疏格式类,从 as_sparse 中读取元素。

chunk_size int (default: 6000)

仅在加载存储为密集型的稀疏数据集时使用。加载会遍历此行大小的数据集的块,直到读取完整个数据集。较大的大小意味着更高的内存消耗和更高的(在某种程度上)加载速度。

Return type:

AnnData