Skip to content

Commit 2682cb6

Browse files
committed
scdl README fixes
1 parent e9def00 commit 2682cb6

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

sub-packages/bionemo-scdl/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,11 +167,13 @@ The runtime is examined on the Tahoe 100M dataset, which containes over 100 mill
167167

168168
![Throughput](https://raw.githubusercontent.com/NVIDIA/bionemo-framework/pbinder/scdl_add_to_edawson/sub-packages/bionemo-scdl/assets/tahoe_throughput.png)
169169

170-
### Using Neighbor Information in Single Cell Datasets
170+
To replicate this on your machine, see: [Tahoe 100M Profiling](https://github.com/NVIDIA/bionemo-framework/blob/main/sub-packages/bionemo-scdl/simple-benchmark/README.md#tahoe-100m) section.
171+
172+
## Using Neighbor Information in Single Cell Datasets
171173

172174
SCDL now supports loading and utilizing neighbor information from AnnData objects. This is particularly useful for tasks that require knowledge of cell neighborhoods, trajectory analysis, or spatial relationships.
173175

174-
#### Neighbor Data Structure in AnnData
176+
### Neighbor Data Structure in AnnData
175177

176178
The neighbor functionality reads neighbor information from the **`.obsp` (observations pairwise) attribute** of the AnnData object and **converts it from sparse matrix format into SCDL's memory-mapped format** for efficient access:
177179

sub-packages/bionemo-scdl/simple-benchmark/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,12 @@ on your system. The following command will run the speedtest on the first plate,
246246
python scdl_speedtest.py --generate-baseline -i tahoe-100m/h5ad/plate1_filt_Vevo_Tahoe100M_WServicesFrom_ParseGigalab.h5ad
247247
```
248248

249+
Alternatively, on the fully converted data:
250+
251+
```bash
252+
python -m bionemo.scdl.simple_benchmark.scdl_speedtest.py --generate-baseline -i <path to Tahoe 100M in h5ad format> --scdl-path <path to Tahoe 100M in SCDL format> --warmup-time 30 --max-time 120
253+
```
254+
249255
## Support
250256

251257
For support, please [file an issue in the BioNeMo Framework GitHub repository](https://github.com/NVIDIA/bionemo-framework/issues).

0 commit comments

Comments
 (0)