Skip to content

Commit 8bbe510

Browse files
authored
VCF-50: Update region_partition and sample_partition parameter descriptions (#869)
* Updated region_partition and sample_partition parameter descriptions
1 parent 3884875 commit 8bbe510

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

apis/python/src/tiledbvcf/dataset.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,11 @@
4747
limit : int
4848
Max number of records (rows) to read
4949
region_partition : tuple
50-
Region partition tuple (idx, num_partitions)
50+
Region partition tuple (idx, num_partitions) partitions regions into
51+
num_partitions partitions and only reads regions from partition idx (0-based)
5152
sample_partition : tuple
52-
Samples partition tuple (idx, num_partitions)
53+
Samples partition tuple (idx, num_partitions) partitions samples into
54+
num_partitions partitions and only reads samples from partition idx (0-based)
5355
sort_regions : bool
5456
Whether or not to sort the regions to be read, default True
5557
memory_budget_mb : int

0 commit comments

Comments
 (0)