bioalpha.h5ad_map.H5ADMap.chunked_X

H5ADMap.chunked_X(axis: int | None = None, shuffle: bool = False, chunk_size: int | None = None, batch_size: int | None = None, random_state: int | None = None)

Return an iterator over the rows of the data matrix X.

Parameters:

  • axis (Optional[0 | 1], default = None) – The axis will be sliced. Default is major axis of X (E.g csc_matrix will be sliced with axis=1)

  • shuffle (bool, default = False) – whether shuffling the chunk or not.

  • chunk_size (Optional[int], default = None) – Row size of a single chunk.

  • batch_size (Optional[int], default = None) – The max number of non zero can be sliced. In compatiple with chunk_size.

  • random_state (Optional[int], default = None) – Only work with shuffle=True. The seed for reproducing shuffle.