Skip to content

Commit 69c7828

Browse files
committed
docs: update deprecated API in Quick Start.
1 parent 9a63dda commit 69c7828

1 file changed

Lines changed: 2 additions & 11 deletions

File tree

docs/source/index.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,6 @@ A PyTorch dependency is **not** included since it may require [special instructi
6060

6161
### Write a [`gvl.Dataset`](api.md#genvarloader.Dataset)
6262

63-
GenVarLoader has both a CLI and Python API for writing datasets. The Python API provides some extra flexibility, for example for a multi-task objective.
64-
65-
```bash
66-
genvarloader cool_dataset.gvl interesting_regions.bed --variants cool_variants.vcf --bigwig-table samples_to_bigwigs.csv --length 2048 --max-jitter 128
67-
```
68-
69-
Where `samples_to_bigwigs.csv` has columns `sample` and `path` mapping each sample to its BigWig.
70-
71-
This could equivalently be done in Python as:
72-
7363
```python
7464
import genvarloader as gvl
7565

@@ -78,11 +68,12 @@ gvl.write(
7868
bed="interesting_regions.bed",
7969
variants="cool_variants.vcf",
8070
bigwigs=gvl.BigWigs.from_table("bigwig", "samples_to_bigwigs.csv"),
81-
length=2048,
8271
max_jitter=128,
8372
)
8473
```
8574

75+
Where `samples_to_bigwigs.csv` has columns `sample` and `path` mapping each sample to its BigWig.
76+
8677
### Open a [`gvl.Dataset`](api.md#genvarloader.Dataset) and get a PyTorch DataLoader
8778

8879
```python

0 commit comments

Comments
 (0)