Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix paddle.vision.datasets.* cn docs #4944

Merged
merged 10 commits into from
Jun 23, 2022
Merged

fix paddle.vision.datasets.* cn docs #4944

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9804ea3
begin a pr (just a placeholder), test=document_fix
SigureMo Jun 17, 2022
142ad6d
refine arguments
SigureMo Jun 18, 2022
9d3e6bd
refine api desc
SigureMo Jun 18, 2022
7296f46
fix wrong COPY-FROM label in Model docs
SigureMo Jun 19, 2022
ec0d866
add some returns
SigureMo Jun 20, 2022
c311919
`默认值：` -> `默认值为 `
SigureMo Jun 20, 2022
274f18d
refine returns
SigureMo Jun 20, 2022
0fc40a9
Merge branch 'develop' into fix-vision-datasets-cn-docs
SigureMo Jun 21, 2022
637f323
COPY-FROM
SigureMo Jun 21, 2022
9558f83
add a blank line in code block
SigureMo Jun 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/api/paddle/Model_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ train_batch(inputs, labels=None, update=True)

**代码示例**

COPY-FROM: paddle.Model:code-example-train-batch
COPY-FROM: paddle.Model.train_batch


eval_batch(inputs, labels=None)
Expand All @@ -77,7 +77,7 @@ list，如果没有定义评估函数，则返回包含了预测损失函数的

**代码示例**

COPY-FROM: paddle.Model:code-example-eval-batch
COPY-FROM: paddle.Model.eval_batch


predict_batch(inputs)
Expand All @@ -96,7 +96,7 @@ predict_batch(inputs)

**代码示例**

COPY-FROM: paddle.Model:code-example-predict-batch
COPY-FROM: paddle.Model.predict_batch


save(path, training=True)
Expand All @@ -117,7 +117,7 @@ save(path, training=True)

**代码示例**

COPY-FROM: paddle.Model:code-example-save
COPY-FROM: paddle.Model.save


load(path, skip_mismatch=False, reset_optimizer=False)
Expand All @@ -138,7 +138,7 @@ load(path, skip_mismatch=False, reset_optimizer=False)

**代码示例**

COPY-FROM: paddle.Model:code-example-load
COPY-FROM: paddle.Model.load


parameters(*args, **kwargs)
Expand All @@ -152,7 +152,7 @@ parameters(*args, **kwargs)

**代码示例**

COPY-FROM: paddle.Model:code-example-parameters
COPY-FROM: paddle.Model.parameters


prepare(optimizer=None, loss=None, metrics=None, amp_configs=None)
Expand Down Expand Up @@ -200,12 +200,12 @@ fit(train_data=None, eval_data=None, batch_size=1, epochs=1, eval_freq=1, log_fr

1. 使用 Dataset 训练，并设置 batch_size 的例子。

COPY-FROM: paddle.Model:code-example-fit-1
COPY-FROM: paddle.Model.fit:code-example1


2. 使用 Dataloader 训练的例子.

COPY-FROM: paddle.Model:code-example-fit-2
COPY-FROM: paddle.Model.fit:code-example2


evaluate(eval_data, batch_size=1, log_freq=10, verbose=2, num_workers=0, callbacks=None, num_iters=None)
Expand All @@ -229,7 +229,7 @@ dict, key是 ``prepare`` 时 Metric 的的名称，value 是该 Metric 的值。

**代码示例**

COPY-FROM: paddle.Model:code-example-evaluate
COPY-FROM: paddle.Model.evaluate


predict(test_data, batch_size=1, num_workers=0, stack_outputs=False, verbose=1, callbacks=None)
Expand All @@ -252,7 +252,7 @@ predict(test_data, batch_size=1, num_workers=0, stack_outputs=False, verbose=1,

**代码示例**

COPY-FROM: paddle.Model:code-example-predict
COPY-FROM: paddle.Model.predict


summary(input_size=None, dtype=None)
Expand All @@ -271,4 +271,4 @@ summary(input_size=None, dtype=None)

**代码示例**

COPY-FROM: paddle.Model:code-example-summary
COPY-FROM: paddle.Model.summary
18 changes: 10 additions & 8 deletions docs/api/paddle/vision/datasets/Cifar100_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,24 @@
Cifar100
-------------------------------

.. py:class:: paddle.vision.datasets.Cifar100()
.. py:class:: paddle.vision.datasets.Cifar100(data_file=None, mode='train', transform=None, download=True, backend=None)


`Cifar-100 <https://www.cs.toronto.edu/~kriz/cifar.html>`_ 数据集的实现，数据集包含100种类别。
`Cifar-100 <https://www.cs.toronto.edu/~kriz/cifar.html>`_ 数据集的实现，包含 100 种类别。

参数
:::::::::
- data_file (str) - 数据集文件路径，如果 ``download`` 参数设置为 ``True`` ， ``data_file`` 参数可以设置为 ``None``。默认值为 ``None``，默认存放在：``~/.cache/paddle/dataset/cifar``
- mode (str) - ``'train'`` 或 ``'test'`` 模式，默认为 ``'train'`` 。
- transform (callable) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为 ``None``。
- download (bool) - 当 ``data_file`` 是 ``None`` 时，该参数决定是否自动下载数据集文件。默认为 ``True`` 。
- backend (str，optional) - 指定要返回的图像类型：PIL.Image或numpy.ndarray。必须是{'pil'，'cv2'}中的值。如果未设置此选项，将从paddle.vsion.get_image_backend获得这个值。默认值：``None`` 。

- **data_file** (str，可选) - 数据集文件路径，如果 ``download`` 参数设置为 ``True``，``data_file`` 参数可以设置为 ``None``。默认值为 ``None``，默认存放在：``~/.cache/paddle/dataset/cifar``。
- **mode** (str，可选) - ``'train'`` 或 ``'test'`` 模式两者之一，默认值为 ``'train'``。
- **transform** (Callable，可选) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为 ``None``。
- **download** (bool，可选) - 当 ``data_file`` 是 ``None`` 时，该参数决定是否自动下载数据集文件。默认值为 ``True``。
- **backend** (str，可选) - 指定要返回的图像类型：PIL.Image 或 numpy.ndarray。必须是 {'pil'，'cv2'} 中的值。如果未设置此选项，将从 :ref:`paddle.vision.get_image_backend <cn_api_vision_image_get_image_backend>` 获得这个值。默认值为 ``None``。

返回
:::::::::

Cifar100数据集实例。
:ref:`cn_api_io_cn_Dataset`，Cifar100 数据集实例。

代码示例
:::::::::
Expand Down
17 changes: 9 additions & 8 deletions docs/api/paddle/vision/datasets/Cifar10_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,24 @@
Cifar10
-------------------------------

.. py:class:: paddle.vision.datasets.Cifar10()
.. py:class:: paddle.vision.datasets.Cifar10(data_file=None, mode='train', transform=None, download=True, backend=None)


`Cifar-10 <https://www.cs.toronto.edu/~kriz/cifar.html>`_ 数据集的实现，数据集包含10种类别。
`Cifar-10 <https://www.cs.toronto.edu/~kriz/cifar.html>`_ 数据集的实现，包含 10 种类别。

参数
:::::::::
- data_file (str) - 数据集文件路径，如果 ``download`` 参数设置为 ``True`` ， ``data_file`` 参数可以设置为 ``None``。默认值为 ``None``，默认存放在：``~/.cache/paddle/dataset/cifar``
- mode (str) - ``'train'`` 或 ``'test'`` 模式，默认为 ``'train'`` 。
- transform (callable) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为 ``None``。
- download (bool) - 当 ``data_file`` 是 ``None`` 时，该参数决定是否自动下载数据集文件。默认为 ``True`` 。
- backend (str，optional) - 指定要返回的图像类型：PIL.Image或numpy.ndarray。必须是{'pil'，'cv2'}中的值。如果未设置此选项，将从paddle.vsion.get_image_backend获得这个值。默认值：``None`` 。

- **data_file** (str，可选) - 数据集文件路径，如果 ``download`` 参数设置为 ``True``，``data_file`` 参数可以设置为 ``None``。默认值为 ``None``，默认存放在：``~/.cache/paddle/dataset/cifar``。
- **mode** (str，可选) - ``'train'`` 或 ``'test'`` 模式两者之一，默认值为 ``'train'``。
- **transform** (Callable，可选) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为 ``None``。
- **download** (bool，可选) - 当 ``data_file`` 是 ``None`` 时，该参数决定是否自动下载数据集文件。默认值为 ``True``。
- **backend** (str，可选) - 指定要返回的图像类型：PIL.Image 或 numpy.ndarray。必须是 {'pil'，'cv2'} 中的值。如果未设置此选项，将从 :ref:`paddle.vision.get_image_backend <cn_api_vision_image_get_image_backend>` 获得这个值。默认值为 ``None``。

返回
:::::::::

Cifar10数据集实例。
:ref:`cn_api_io_cn_Dataset`，Cifar10 数据集实例。

代码示例
:::::::::
Expand Down
36 changes: 25 additions & 11 deletions docs/api/paddle/vision/datasets/DatasetFolder_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,40 @@ DatasetFolder

.. py:class:: paddle.vision.datasets.DatasetFolder(root, loader=None, extensions=None, transform=None, is_valid_file=None)

一种通用的数据加载方式，输入以如下的格式存放：

一种通用的数据加载方式，数据需要以如下的格式存放：

.. code-block:: text
root/class_a/1.ext
root/class_a/2.ext
root/class_a/3.ext
root/class_a/1.ext
root/class_a/2.ext
root/class_a/3.ext

root/class_b/123.ext
root/class_b/456.ext
root/class_b/789.ext

root/class_b/123.ext
root/class_b/456.ext
root/class_b/789.ext

参数
::::::::::::

- **root** (str) - 根目录路径。
- **loader** (callable，可选) - 可以加载数据路径的一个函数，如果该值没有设定，默认使用 ``cv2.imread``。默认值：None。
- **extensions** (tuple[str]，可选) - 允许的数据后缀列表，如果该值没有设定，默认使用 ``('.jpg', '.jpeg', '.png', '.ppm', '.bmp', '.pgm', '.tif', '.tiff', '.webp')``。默认值：None。
- **transform** (callable，可选) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为``None``。
- **is_valid_file** (callable，可选) - 根据每条数据的路径来判断是否合法的一个函数。默认值：None。
- **loader** (Callable，可选) - 可以加载数据路径的一个函数，如果该值没有设定，默认使用 ``cv2.imread``。默认值为 None。
- **extensions** (list[str]|tuple[str]，可选) - 允许的数据后缀列表，``extensions`` 和 ``is_valid_file`` 不可以同时设置。如果该值没有设定，默认为 ``('.jpg', '.jpeg', '.png', '.ppm', '.bmp', '.pgm', '.tif', '.tiff', '.webp')``。默认值为 None。
- **transform** (Callable，可选) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为 ``None``。
- **is_valid_file** (Callable，可选) - 根据每条数据的路径来判断是否合法的一个函数。``extensions`` 和 ``is_valid_file`` 不可以同时设置。默认值为 None。

返回
:::::::::

:ref:`cn_api_io_cn_Dataset`，DatasetFolder 实例。

属性
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

属性部分请参考规范

Copy link
Member Author

@SigureMo SigureMo Jun 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

刚刚看了一下，但关于属性我有很大的疑问，这个属性如果中文文档这么写的话，英文文档要往哪里写呢？因为属性是不同于方法没有一个地方写 docstring 的呀（应该是这样子的吧）？

我看了下示例的 paddle.static.Program（paddle.Program 没有找到，貌似是 API 改名了？），我发现文档里暴露的属性都是 @property 装饰（或者说 getter）后的属性，这些属性确实是可以写 docstring，但相应的，非 @property 装饰的属性要如何写 docstring 呢？而且这个 API 文档里貌似有点混乱，属性里混入了大量的方法

image

唔，我又翻看了一些其他的类，貌似并没有找到相关可以参考的内容（非 @property 装饰的暴露的属性且中英文文档都完善的）～所以说属性的话是不管英文文档嘛？

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TCChenlong 呼唤龙哥，这个标准怎么说？

::::::::::::

- **classes** (list[str]) - 包含全部类名的列表。
- **class_to_idx** (dict[str, int]) - 类名到类别索引号的映射字典。
- **samples** (list[tuple[str, int]]) - 一个列表，其中每项为 ``(样本路径, 类别索引号)`` 形式的元组。
- **targets** (list[int]) - 数据集中各个图片的类别索引号列表。

代码示例
::::::::::::
Expand Down
18 changes: 10 additions & 8 deletions docs/api/paddle/vision/datasets/FashionMNIST_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,25 @@
FashionMNIST
-------------------------------

.. py:class:: paddle.vision.datasets.FashionMNIST()
.. py:class:: paddle.vision.datasets.FashionMNIST(image_path=None, label_path=None, mode='train', transform=None, download=True, backend=None)


`Fashion-MNIST <https://github.com/zalandoresearch/fashion-mnist>`_ 数据集。
`Fashion-MNIST <https://github.com/zalandoresearch/fashion-mnist>`_ 数据集的实现。

参数
:::::::::
- image_path (str) - 图像文件路径，如果 ``download`` 参数设置为 ``True`` ， ``image_path`` 参数可以设置为 ``None``。默认值为 ``None`` 。
- label_path (str) - 标签文件路径，如果 ``download`` 参数设置为 ``True`` ， ``label_path`` 参数可以设置为 ``None``。默认值为 ``None`` 。
- mode (str) - ``'train'`` 或 ``'test'`` 模式，默认为 ``'train'`` 。
- download (bool) - 当 ``data_file`` 是 ``None`` 时，该参数决定是否自动下载数据集文件。默认为 ``True`` 。
- backend (str，optional) - 指定要返回的图像类型：PIL.Image或numpy.ndarray。必须是{'pil'，'cv2'}中的值。如果未设置此选项，将从paddle.vsion.get_image_backend获得这个值。默认值：``None`` 。

- **image_path** (str，可选) - 图像文件路径，如果 ``download`` 参数设置为 ``True``，``image_path`` 参数可以设置为 ``None``。默认值为 ``None``，默认存放在：``~/.cache/paddle/dataset/fashion-mnist``。
- **label_path** (str，可选) - 标签文件路径，如果 ``download`` 参数设置为 ``True``，``label_path`` 参数可以设置为 ``None``。默认值为 ``None``，默认存放在：``~/.cache/paddle/dataset/fashion-mnist``。
- **mode** (str，可选) - ``'train'`` 或 ``'test'`` 模式两者之一，默认值为 ``'train'``。
- **transform** (Callable，可选) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为 ``None``。
- **download** (bool，可选) - 当 ``data_file`` 是 ``None`` 时，该参数决定是否自动下载数据集文件。默认值为 ``True``。
- **backend** (str，可选) - 指定要返回的图像类型：PIL.Image 或 numpy.ndarray。必须是 {'pil'，'cv2'} 中的值。如果未设置此选项，将从 :ref:`paddle.vision.get_image_backend <cn_api_vision_image_get_image_backend>` 获得这个值。默认值为 ``None``。

返回
:::::::::

FashionMNIST数据集实例。
:ref:`cn_api_io_cn_Dataset`，FashionMNIST 数据集实例。

代码示例
:::::::::
Expand Down
21 changes: 11 additions & 10 deletions docs/api/paddle/vision/datasets/Flowers_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,26 @@
Flowers
-------------------------------

.. py:class:: paddle.vision.datasets.Flowers()
.. py:class:: paddle.vision.datasets.Flowers(data_file=None, label_file=None, setid_file=None, mode='train', transform=None, download=True, backend=None)


`Flowers102 <https://www.robots.ox.ac.uk/~vgg/data/flowers/>`_ 数据集。
`Flowers102 <https://www.robots.ox.ac.uk/~vgg/data/flowers/>`_ 数据集的实现。

参数
:::::::::
- data_file (str) - 数据文件路径，如果 ``download`` 参数设置为 ``True`` ， ``data_file`` 参数可以设置为 ``None``。默认值为 ``None`` 。
- label_file (str) - 标签文件路径，如果 ``download`` 参数设置为 ``True`` ， ``label_file`` 参数可以设置为 ``None``。默认值为 ``None`` 。
- setid_file (str) - 子数据集下标划分文件路径，如果 ``download`` 参数设置为 ``True`` ， ``setid_file`` 参数可以设置为 ``None``。默认值为 ``None`` 。
- mode (str) - ``'train'`` 或 ``'test'`` 模式，默认为 ``'train'`` 。
- transform (callable) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为 ``None``。
- download (bool) - 当 ``data_file`` 是 ``None`` 时，该参数决定是否自动下载数据集文件。默认为 ``True`` 。
- backend (str，optional) - 指定要返回的图像类型：PIL.Image或numpy.ndarray。必须是{'pil'，'cv2'}中的值。如果未设置此选项，将从paddle.vsion.get_image_backend获得这个值。默认值：``None`` 。

- **data_file** (str，可选) - 数据文件路径，如果 ``download`` 参数设置为 ``True``， ``data_file`` 参数可以设置为 ``None``。默认值为 ``None``，默认存放在：``~/.cache/paddle/dataset/flowers``。
- **label_file** (str，可选) - 标签文件路径，如果 ``download`` 参数设置为 ``True``， ``label_file`` 参数可以设置为 ``None``。默认值为 ``None``，默认存放在：``~/.cache/paddle/dataset/flowers``。
- **setid_file** (str，可选) - 子数据集下标划分文件路径，如果 ``download`` 参数设置为 ``True`` ， ``setid_file`` 参数可以设置为 ``None``。默认值为 ``None``，默认存放在：``~/.cache/paddle/dataset/flowers``。
- **mode** (str，可选) - ``'train'`` 或 ``'test'`` 模式两者之一，默认值为 ``'train'``。
- **transform** (Callable，可选) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为 ``None``。
- **download** (bool，可选) - 当 ``data_file`` 是 ``None`` 时，该参数决定是否自动下载数据集文件。默认值为 ``True``。
- **backend** (str，可选) - 指定要返回的图像类型：PIL.Image 或 numpy.ndarray。必须是 {'pil'，'cv2'} 中的值。如果未设置此选项，将从 :ref:`paddle.vision.get_image_backend <cn_api_vision_image_get_image_backend>` 获得这个值。默认值为 ``None``。

返回
:::::::::

Flowers数据集实例。
:ref:`cn_api_io_cn_Dataset`，Flowers 数据集实例。

代码示例
:::::::::
Expand Down
27 changes: 19 additions & 8 deletions docs/api/paddle/vision/datasets/ImageFolder_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,33 @@ ImageFolder

.. py:class:: paddle.vision.datasets.ImageFolder(root, loader=None, extensions=None, transform=None, is_valid_file=None)

一种通用的数据加载方式，输入以如下的格式存放：

一种通用的数据加载方式，数据需要以如下的格式存放：

.. code-block:: text
root/1.ext
root/2.ext
root/sub_dir/3.ext
root/1.ext
root/2.ext
root/sub_dir/3.ext


参数
::::::::::::

- **root** (str) - 根目录路径。
- **loader** (callable，可选) - 可以加载数据路径的一个函数，如果该值没有设定，默认使用 ``cv2.imread``。默认值：None。
- **extensions** (tuple[str]，可选) - 允许的数据后缀列表，如果该值没有设定，默认使用 ``('.jpg', '.jpeg', '.png', '.ppm', '.bmp', '.pgm', '.tif', '.tiff', '.webp')``。默认值：None。
- **transform** (callable，可选) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为``None``。
- **is_valid_file** (callable，可选) - 根据每条数据的路径来判断是否合法的一个函数。默认值：None。
- **loader** (Callable，可选) - 可以加载数据路径的一个函数，如果该值没有设定，默认使用 ``cv2.imread``。默认值为 None。
- **extensions** (list[str]|tuple[str]，可选) - 允许的数据后缀列表，``extensions`` 和 ``is_valid_file`` 不可以同时设置。如果该值没有设定，默认为 ``('.jpg', '.jpeg', '.png', '.ppm', '.bmp', '.pgm', '.tif', '.tiff', '.webp')``。默认值为 None。
- **transform** (Callable，可选) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为 ``None``。
- **is_valid_file** (Callable，可选) - 根据每条数据的路径来判断是否合法的一个函数。``extensions`` 和 ``is_valid_file`` 不可以同时设置。默认值为 None。

返回
:::::::::

:ref:`cn_api_io_cn_Dataset`，ImageFolder 实例。

属性
::::::::::::

- **samples** (list[str]) - 样本路径列表。

代码示例
::::::::::::
Expand Down
18 changes: 10 additions & 8 deletions docs/api/paddle/vision/datasets/MNIST_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,25 @@
MNIST
-------------------------------

.. py:class:: paddle.vision.datasets.MNIST()
.. py:class:: paddle.vision.datasets.MNIST(image_path=None, label_path=None, mode='train', transform=None, download=True, backend=None)


`MNIST <http://yann.lecun.com/exdb/mnist/>`_ 数据集。
`MNIST <http://yann.lecun.com/exdb/mnist/>`_ 数据集的实现。

参数
:::::::::
- image_path (str) - 图像文件路径，如果 ``download`` 参数设置为 ``True`` ， ``image_path`` 参数可以设置为 ``None``。默认值为 ``None`` 。
- label_path (str) - 标签文件路径，如果 ``download`` 参数设置为 ``True`` ， ``label_path`` 参数可以设置为 ``None``。默认值为 ``None`` 。
- mode (str) - ``'train'`` 或 ``'test'`` 模式，默认为 ``'train'`` 。
- download (bool) - 当 ``data_file`` 是 ``None`` 时，该参数决定是否自动下载数据集文件。默认为 ``True`` 。
- backend(str，可选）- 指定图像的返回类型：PIL.Image 或 numpy.ndarray。应该是``{'pil'，'cv2'}`` 之一。如果未设置此选项，将从paddle.vsion.get_image_backend获取，默认为 ``pil``。默认值：None。

- **image_path** (str，可选) - 图像文件路径，如果 ``download`` 参数设置为 ``True``，``image_path`` 参数可以设置为 ``None``。默认值为 ``None``，默认存放在：``~/.cache/paddle/dataset/mnist``。
- **label_path** (str，可选) - 标签文件路径，如果 ``download`` 参数设置为 ``True``，``label_path`` 参数可以设置为 ``None``。默认值为 ``None``，默认存放在：``~/.cache/paddle/dataset/mnist``。
- **mode** (str，可选) - ``'train'`` 或 ``'test'`` 模式两者之一，默认值为 ``'train'``。
- **transform** (Callable，可选) - 图片数据的预处理，若为 ``None`` 即为不做预处理。默认值为 ``None``。
- **download** (bool，可选) - 当 ``data_file`` 是 ``None`` 时，该参数决定是否自动下载数据集文件。默认值为 ``True``。
- **backend** (str，可选) - 指定要返回的图像类型：PIL.Image 或 numpy.ndarray。必须是 {'pil'，'cv2'} 中的值。如果未设置此选项，将从 :ref:`paddle.vision.get_image_backend <cn_api_vision_image_get_image_backend>` 获得这个值。默认值为 ``None``。

返回
:::::::::

MNIST数据集实例。
:ref:`cn_api_io_cn_Dataset`，MNIST 数据集实例。

代码示例
:::::::::
Expand Down
Loading