Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.72 KB

BatchSampler_cn.rst

File metadata and controls

35 lines (22 loc) · 1.72 KB
Raw

BatchSampler

.. py:class:: paddle.io.BatchSampler(dataset=None, sampler=None, shuffle=False, batch_size=1, drop_last=False)

批采样器的基础实现，用于 paddle.io.DataLoader 中迭代式获取 mini-batch 的样本下标数组，数组长度与 batch_size 一致。

所有用于 paddle.io.DataLoader 中的批采样器都必须是 paddle.io.BatchSampler 的子类并实现以下方法：

__iter__ ：迭代式返回批样本下标数组。

__len__ ：每 epoch 中 mini-batch 数。

参数

  • dataset (Dataset，可选) - 此参数必须是 :ref:`cn_api_io_cn_Dataset` 或 :ref:`cn_api_io_cn_IterableDataset` 的一个子类实例或实现了 __len__ 的 Python 对象，用于生成样本下标。默认值为 None, 表示不使用此参数。
  • sampler (Sampler，可选) - 此参数必须是 :ref:`cn_api_io_cn_Sampler` 的子类实例，用于迭代式获取样本下标。 dataset 和 sampler 参数只能设置一个。默认值为 None, 表示不使用此参数。
  • shuffle (bool，可选) - 是否需要在生成样本下标时打乱顺序。默认值为 False ，表示不打乱顺序。
  • batch_size (int，可选) - 每 mini-batch 中包含的样本数。默认值为 1 ，表示每 mini-batch 中包含 1 个样本数。
  • drop_last (bool，可选) - 是否需要丢弃最后无法凑整一个 mini-batch 的样本。默认值为 False ，表示不丢弃最后无法凑整一个 mini-batch 的样本。

见 :ref:`cn_api_fluid_io_DataLoader` 。

返回

BatchSampler， 返回样本下标数组的迭代器。

代码示例

COPY-FROM: paddle.io.BatchSampler