Biogod commited on
Commit
019a02d
·
verified ·
1 Parent(s): 68b3374

Dataset card: no-login starter pack section and gallery

Browse files
README.md CHANGED
@@ -27,13 +27,50 @@ workflow (7,777 samples, each checked by an independent scorer) and by the earli
27
  samples, each reviewed by eye). The atlas is described in the
28
  [bioRxiv preprint](https://doi.org/10.64898/2026.05.27.727615).
29
 
30
- This repository holds **metadata only** and needs no account. The expression matrices (H5AD), images (TIFF) and
31
- per-sample JSON are in the [full dataset](https://huggingface.co/datasets/Biogod/SpatialDataAgent-DB), about
32
- 1.8 TB in total. Every file of the release has passed content verification. To get the files:
 
33
 
34
- 1. Request access on that page with your Hugging Face account and an institutional e-mail; requests are reviewed
35
- manually.
36
- 2. After approval, run `hf auth login` (or set `HF_TOKEN`).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
37
 
38
  ## Is my tissue here?
39
 
@@ -130,7 +167,7 @@ checks every file against its SHA256, and reads samples as AnnData. Streaming-re
130
  planned follow-up. AI agents can use the same tools through its
131
  MCP server (`sda-db mcp`).
132
 
133
- With approved access, load a sample and cut an image patch paired with a spot:
134
 
135
  ```python
136
  import json
@@ -138,7 +175,7 @@ import sda_db
138
  from sda_db.io import image_coordinates
139
  from sda_db.image import read_patch
140
 
141
- adata = sda_db.load("GSM8915497", include_image=True) # verified download, then AnnData with release metadata
142
  meta = json.loads(adata.uns["sda_db"]["sample_json"])
143
  pixels = image_coordinates(adata, meta) # image pixel position of every spot
144
  patch, _ = read_patch(adata.uns["sda_db"]["directory"], pixels[0], 224) # H&E patch paired with adata.X[0]
 
27
  samples, each reviewed by eye). The atlas is described in the
28
  [bioRxiv preprint](https://doi.org/10.64898/2026.05.27.727615).
29
 
30
+ This repository needs **no account**. It holds the catalog of all 12,163 samples and the complete files of 88
31
+ starter samples (below). The files of every sample are in the
32
+ [full dataset](https://huggingface.co/datasets/Biogod/SpatialDataAgent-DB), about 1.8 TB, where access is
33
+ approved manually.
34
 
35
+ ## Try it now, without an account: the starter pack
36
+
37
+ ![24 of the starter pack's samples with a tissue image](assets/dataset-card/v3/08-starter-gallery.png)
38
+
39
+ 88 samples of the release are in this repository and need **no login**. Each has the full three files:
40
+ `spatial.h5ad`, `sample.json` and, for 60 of them, `image.tif`. The pack covers:
41
+
42
+ - 12 platforms, 20 organ groups and 8 species;
43
+ - 46 H&E images and 14 DAPI or CosMx images;
44
+ - 42 samples with a reported disease and 79 from published studies;
45
+ - 3.9 GB in total.
46
+
47
+ The files are byte-identical to the full dataset, and each is checked against its SHA256 when downloaded.
48
+ `starter/starter.json` lists the samples.
49
+
50
+ [Open the five-minute notebook in Colab](https://colab.research.google.com/github/Biogod2020/spatial-data-agent-db/blob/main/examples/starter_pack.ipynb),
51
+ or:
52
+
53
+ ```bash
54
+ pip install "spatial-data-agent-db[analysis] @ git+https://github.com/Biogod2020/spatial-data-agent-db"
55
+ sda-db starter --has-image # list the pack
56
+ sda-db download GSM4284327 --release starter --include-image # human skin cancer, H&E at 0.76 µm per pixel
57
+ ```
58
+
59
+ ```python
60
+ import sda_db
61
+ adata = sda_db.load("GSM4284327", release="starter", include_image=True)
62
+ ```
63
+
64
+ From R, or any tool, download a starter sample's files directly, for example
65
+ `https://huggingface.co/datasets/Biogod/SpatialDataAgent-DB-Catalog/resolve/main/samples/GSE144239/GSM4284327/spatial.h5ad`
66
+ (also `sample.json` and `image.tif`), and read the H5AD with `zellkonverter::readH5AD`.
67
+
68
+ **All 12,163 samples.** Every file of the release has passed content verification. To download any sample:
69
+
70
+ 1. Request access on the [full dataset page](https://huggingface.co/datasets/Biogod/SpatialDataAgent-DB) with
71
+ your Hugging Face account and an institutional e-mail; requests are reviewed manually.
72
+ 2. After approval, run `hf auth login` (or set `HF_TOKEN`). The same commands then work without
73
+ `--release starter`.
74
 
75
  ## Is my tissue here?
76
 
 
167
  planned follow-up. AI agents can use the same tools through its
168
  MCP server (`sda-db mcp`).
169
 
170
+ Load a starter sample (no login) and cut an image patch paired with one spot:
171
 
172
  ```python
173
  import json
 
175
  from sda_db.io import image_coordinates
176
  from sda_db.image import read_patch
177
 
178
+ adata = sda_db.load("GSM4284327", release="starter", include_image=True) # verified download, then AnnData
179
  meta = json.loads(adata.uns["sda_db"]["sample_json"])
180
  pixels = image_coordinates(adata, meta) # image pixel position of every spot
181
  patch, _ = read_patch(adata.uns["sda_db"]["directory"], pixels[0], 224) # H&E patch paired with adata.X[0]
assets/dataset-card/v3/08-starter-gallery.png ADDED

Git LFS Details

  • SHA256: c3f7e09d9bf99e7090ea2b4b6da4abf154f3e45e03237e8671739468ddd936b8
  • Pointer size: 132 Bytes
  • Size of remote file: 2.32 MB