From a56c468d30242b49509e0b353db679b18649d486 Mon Sep 17 00:00:00 2001 From: Adam Narozniak Date: Sat, 22 Jun 2024 16:06:02 +0200 Subject: [PATCH] List the partitioners --- datasets/doc/source/index.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/datasets/doc/source/index.rst b/datasets/doc/source/index.rst index ca3a3c7c4239..1f43662c37f8 100644 --- a/datasets/doc/source/index.rst +++ b/datasets/doc/source/index.rst @@ -74,6 +74,19 @@ Thanks to using Hugging Face's ``datasets`` used under the hood, Flower Datasets - Jax - Arrow +Here are a few of the ``Partitioner`` s that are available: (for a full list see `link `_ ) + +* Partitioner (the abstract base class) ``Partitioner`` +* IID partitioning ``IidPartitioner(num_partitions)`` +* Dirichlet partitioning ``DirichletPartitioner(num_partitions, partition_by, alpha)`` +* InnerDirichlet partitioning ``InnerDirichletPartitioner(partition_sizes, partition_by, alpha)`` +* Natural ID partitioner ``NaturalIdPartitioner(partition_by)`` +* Size partitioner (the abstract base class for the partitioners dictating the division based the number of samples) ``SizePartitioner`` +* Linear partitioner ``LinearPartitioner(num_partitions)`` +* Square partitioner ``SquarePartitioner(num_partitions)`` +* Exponential partitioner ``ExponentialPartitioner(num_partitions)`` +* more to come in the future releases (contributions are welcome). + Install -------