Biogod commited on
Commit
042ef77
·
verified ·
1 Parent(s): 1bc9257

Publish HESRT 2026-09-17-v1.1: card, catalogs, real previews and verified usage examples

Browse files
CHANGELOG.md CHANGED
@@ -1,6 +1,8 @@
1
  # Release notes
2
 
3
- ## 2026-09-17-v1 — publication completed 2026-09-18
 
 
4
 
5
  The versioned release contains 4,468 sample packages from 507 GEO studies. Packaging receipts report 37,054,005 expression observations, 413,935,652,096 compressed bytes and 647,719,556,166 uncompressed member bytes. The existing sample packages and legacy repository paths are preserved.
6
 
 
1
  # Release notes
2
 
3
+ ## 2026-09-17-v1.1 — documentation patch, 2026-09-18
4
+
5
+ The download bootstrap now uses the public Python API, avoiding a CLI dependency incompatibility observed in a fresh environment. Sample package bytes are unchanged from 2026-09-17-v1; the original tag remains intact.
6
 
7
  The versioned release contains 4,468 sample packages from 507 GEO studies. Packaging receipts report 37,054,005 expression observations, 413,935,652,096 compressed bytes and 647,719,556,166 uncompressed member bytes. The existing sample packages and legacy repository paths are preserved.
8
 
README.md CHANGED
@@ -58,8 +58,7 @@ Python 3.11+. The examples resolve a single revision, verify checksums, extract
58
 
59
  ```bash
60
  python -m pip install "huggingface_hub>=0.34,<2"
61
- hf download Biogod/HESRT --repo-type dataset --revision 2026-09-17-v1 \
62
- --include 'examples/*' --local-dir hesrt_tools
63
  python -m pip install -r hesrt_tools/examples/requirements.txt
64
  python hesrt_tools/examples/quickstart.py --output hesrt_demo
65
  ```
@@ -73,7 +72,7 @@ from huggingface_hub import HfApi, hf_hub_download
73
  import pandas as pd
74
 
75
  revision = HfApi(token=False).dataset_info(
76
- "Biogod/HESRT", revision="2026-09-17-v1"
77
  ).sha
78
  catalog = pd.read_parquet(hf_hub_download(
79
  "Biogod/HESRT", "releases/2026-09-17/catalog.parquet",
@@ -125,4 +124,4 @@ For evaluation, keep studies and shared content together, resolve donor/cohort o
125
 
126
  ## Reuse and citation
127
 
128
- Underlying source materials retain their source-specific terms; no blanket redistribution license is asserted. Cite the source GEO accessions/publications and **HESRT release 2026-09-17-v1**, recording its resolved Hub commit. See [reuse and citation](docs/REUSE.md) and [release notes](CHANGELOG.md). This resource is intended for research, not clinical decision making.
 
58
 
59
  ```bash
60
  python -m pip install "huggingface_hub>=0.34,<2"
61
+ python -c "from huggingface_hub import snapshot_download; snapshot_download('Biogod/HESRT', repo_type='dataset', revision='2026-09-17-v1.1', allow_patterns=['examples/*'], local_dir='hesrt_tools', token=False, max_workers=4)"
 
62
  python -m pip install -r hesrt_tools/examples/requirements.txt
63
  python hesrt_tools/examples/quickstart.py --output hesrt_demo
64
  ```
 
72
  import pandas as pd
73
 
74
  revision = HfApi(token=False).dataset_info(
75
+ "Biogod/HESRT", revision="2026-09-17-v1.1"
76
  ).sha
77
  catalog = pd.read_parquet(hf_hub_download(
78
  "Biogod/HESRT", "releases/2026-09-17/catalog.parquet",
 
124
 
125
  ## Reuse and citation
126
 
127
+ Underlying source materials retain their source-specific terms; no blanket redistribution license is asserted. Cite the source GEO accessions/publications and **HESRT release 2026-09-17-v1.1**, recording its resolved Hub commit. See [reuse and citation](docs/REUSE.md) and [release notes](CHANGELOG.md). This resource is intended for research, not clinical decision making.
docs/REUSE.md CHANGED
@@ -8,11 +8,11 @@ The collection is intended for research and benchmarking, not clinical decision
8
 
9
  ## Cite the exact version and source studies
10
 
11
- Cite the underlying GEO accession and publication for each study used. Additionally identify **HESRT release 2026-09-17-v1**, hosted at `Biogod/HESRT`, and preserve the immutable commit resolved from that tag in the analysis record. A minimal dataset reference is:
12
 
13
  ```bibtex
14
  @misc{hesrt20260917,
15
- title = {HESRT: Human-reviewed spatial-omics sample artifacts, release 2026-09-17-v1},
16
  year = {2026},
17
  howpublished = {Hugging Face dataset repository},
18
  url = {https://huggingface.co/datasets/Biogod/HESRT},
 
8
 
9
  ## Cite the exact version and source studies
10
 
11
+ Cite the underlying GEO accession and publication for each study used. Additionally identify **HESRT release 2026-09-17-v1.1**, hosted at `Biogod/HESRT`, and preserve the immutable commit resolved from that tag in the analysis record. A minimal dataset reference is:
12
 
13
  ```bibtex
14
  @misc{hesrt20260917,
15
+ title = {HESRT: Human-reviewed spatial-omics sample artifacts, release 2026-09-17-v1.1},
16
  year = {2026},
17
  howpublished = {Hugging Face dataset repository},
18
  url = {https://huggingface.co/datasets/Biogod/HESRT},
docs/USAGE.md CHANGED
@@ -6,8 +6,7 @@ Use Python 3.11 or newer. Start with the catalog, not a clone or full snapshot o
6
 
7
  ```bash
8
  python -m pip install "huggingface_hub>=0.34,<2"
9
- hf download Biogod/HESRT --repo-type dataset --revision 2026-09-17-v1 \
10
- --include 'examples/*' --local-dir hesrt_tools
11
  python -m pip install -r hesrt_tools/examples/requirements.txt
12
  ```
13
 
@@ -21,7 +20,7 @@ import pandas as pd
21
 
22
  repo = "Biogod/HESRT"
23
  revision = HfApi(token=False).dataset_info(
24
- repo, revision="2026-09-17-v1"
25
  ).sha
26
  path = hf_hub_download(repo, "releases/2026-09-17/catalog.parquet",
27
  repo_type="dataset", revision=revision, token=False)
@@ -44,7 +43,7 @@ The native Dataset Viewer offers `reviewed_catalog` (all 4,468 catalog rows), `s
44
  ```python
45
  from datasets import load_dataset
46
  rows = load_dataset("Biogod/HESRT", "reviewed_catalog",
47
- split="reviewed", revision="2026-09-17-v1")
48
  print(rows[0]["gsm_id"])
49
  ```
50
 
 
6
 
7
  ```bash
8
  python -m pip install "huggingface_hub>=0.34,<2"
9
+ python -c "from huggingface_hub import snapshot_download; snapshot_download('Biogod/HESRT', repo_type='dataset', revision='2026-09-17-v1.1', allow_patterns=['examples/*'], local_dir='hesrt_tools', token=False, max_workers=4)"
 
10
  python -m pip install -r hesrt_tools/examples/requirements.txt
11
  ```
12
 
 
20
 
21
  repo = "Biogod/HESRT"
22
  revision = HfApi(token=False).dataset_info(
23
+ repo, revision="2026-09-17-v1.1"
24
  ).sha
25
  path = hf_hub_download(repo, "releases/2026-09-17/catalog.parquet",
26
  repo_type="dataset", revision=revision, token=False)
 
43
  ```python
44
  from datasets import load_dataset
45
  rows = load_dataset("Biogod/HESRT", "reviewed_catalog",
46
+ split="reviewed", revision="2026-09-17-v1.1")
47
  print(rows[0]["gsm_id"])
48
  ```
49
 
examples/hesrt_io.py CHANGED
@@ -14,7 +14,7 @@ import zstandard as zstd
14
  from huggingface_hub import HfApi, hf_hub_download
15
 
16
  REPO_ID = "Biogod/HESRT"
17
- RELEASE_TAG = "2026-09-17-v1"
18
  PREFIX = "releases/2026-09-17/"
19
 
20
 
 
14
  from huggingface_hub import HfApi, hf_hub_download
15
 
16
  REPO_ID = "Biogod/HESRT"
17
+ RELEASE_TAG = "2026-09-17-v1.1"
18
  PREFIX = "releases/2026-09-17/"
19
 
20
 
releases/2026-09-17/release.json CHANGED
@@ -9,9 +9,9 @@
9
  "all_source_binary_hashes_recomputed": true,
10
  "roundtrip_verified_packages": 2,
11
  "matrix_image_transformation": "none; byte-identical lossless packaging",
12
- "published_at": "2026-09-18T02:51:04.534135+00:00",
13
  "repo_id": "Biogod/HESRT",
14
- "payload_verified_commit": "fb10cbce420577f1dddf47ee240418e6c47a158b",
15
  "documentation_version": "2026-09-18-closeout",
16
  "preview_samples": 9,
17
  "payload_integrity_check": "All 4468 remote LFS SHA256 values and sizes match packages.json"
 
9
  "all_source_binary_hashes_recomputed": true,
10
  "roundtrip_verified_packages": 2,
11
  "matrix_image_transformation": "none; byte-identical lossless packaging",
12
+ "published_at": "2026-09-18T02:57:13.346496+00:00",
13
  "repo_id": "Biogod/HESRT",
14
+ "payload_verified_commit": "1bc925740471d85776246fa6b99ca147b9672195",
15
  "documentation_version": "2026-09-18-closeout",
16
  "preview_samples": 9,
17
  "payload_integrity_check": "All 4468 remote LFS SHA256 values and sizes match packages.json"