From 2b1fc7d19d4d45f710eb7a7d258055d5c1882fbd Mon Sep 17 00:00:00 2001 From: Chong Shen Ng Date: Mon, 15 Jul 2024 15:35:03 +0100 Subject: [PATCH] Update documentation for DistributionPartitioner --- datasets/README.md | 1 + datasets/doc/source/index.rst | 1 + 2 files changed, 2 insertions(+) diff --git a/datasets/README.md b/datasets/README.md index 50fc67376ae4..71207af2d699 100644 --- a/datasets/README.md +++ b/datasets/README.md @@ -41,6 +41,7 @@ Create **custom partitioning schemes** or choose from the **implemented [partiti * Partitioner (the abstract base class) `Partitioner` * IID partitioning `IidPartitioner(num_partitions)` * Dirichlet partitioning `DirichletPartitioner(num_partitions, partition_by, alpha)` +* Distribution partitioning `DistributionPartitioner(distribution_array, num_partitions, num_unique_labels_per_partition, partition_by, preassigned_num_samples_per_label, rescale)` * InnerDirichlet partitioning `InnerDirichletPartitioner(partition_sizes, partition_by, alpha)` * Pathological partitioning `PathologicalPartitioner(num_partitions, partition_by, num_classes_per_partition, class_assignment_mode)` * Natural ID partitioning `NaturalIdPartitioner(partition_by)` diff --git a/datasets/doc/source/index.rst b/datasets/doc/source/index.rst index fcc7920711bf..6d707de7dd42 100644 --- a/datasets/doc/source/index.rst +++ b/datasets/doc/source/index.rst @@ -93,6 +93,7 @@ Here are a few of the ``Partitioner`` s that are available: (for a full list see * Partitioner (the abstract base class) ``Partitioner`` * IID partitioning ``IidPartitioner(num_partitions)`` * Dirichlet partitioning ``DirichletPartitioner(num_partitions, partition_by, alpha)`` +* Distribution partitioning ``DistributionPartitioner(distribution_array, num_partitions, num_unique_labels_per_partition, partition_by, preassigned_num_samples_per_label, rescale)`` * InnerDirichlet partitioning ``InnerDirichletPartitioner(partition_sizes, partition_by, alpha)`` * PathologicalPartitioner ``PathologicalPartitioner(num_partitions, partition_by, num_classes_per_partition, class_assignment_mode)`` * Natural ID partitioner ``NaturalIdPartitioner(partition_by)``