Skip to content
This repository has been archived by the owner on Jan 2, 2025. It is now read-only.

Commit

Permalink
πŸ“ Update docs for Artifact.open (#446)
Browse files Browse the repository at this point in the history
Update docs for Artifact.open
  • Loading branch information
Koncopd authored Oct 29, 2024
1 parent 9a5d043 commit 35f4d90
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion lnschema_core/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -2340,6 +2340,9 @@ def open(
):
"""Return a cloud-backed data object.
Works for `AnnData` (`.h5ad` and `.zarr`), generic `hdf5` and `zarr`,
`tiledbsoma` objects (`.tiledbsoma`), `pyarrow` compatible formats.
Args:
mode: can only be `"w"` (write mode) for `tiledbsoma` stores,
otherwise should be always `"r"` (read-only mode).
Expand All @@ -2353,7 +2356,9 @@ def open(
>>> artifact = ln.Artifact.get(key="lndb-storage/pbmc68k.h5ad")
>>> artifact.open()
AnnData object with n_obs Γ— n_vars = 70 Γ— 765 backed at 's3://lamindb-ci/lndb-storage/pbmc68k.h5ad'
AnnDataAccessor object with n_obs Γ— n_vars = 70 Γ— 765
constructed for the AnnData object pbmc68k.h5ad
...
"""
pass

Expand Down

0 comments on commit 35f4d90

Please sign in to comment.