mindspore/docs/api/api_python/dataset/mindspore.dataset.DSCallbac...

47 lines
1.7 KiB
ReStructuredText
Raw Normal View History

2021-11-22 14:54:00 +08:00
mindspore.dataset.DSCallback
2021-11-25 16:44:52 +08:00
=============================
2021-11-22 14:54:00 +08:00
.. py:class:: mindspore.dataset.DSCallback(step_size=1)
2022-01-13 11:46:37 +08:00
数据处理回调类的抽象基类,用户可以基于此类实现自己的回调操作。
用户可通过 `ds_run_context` 获取数据处理管道相关信息,包括 `cur_epoch_num` (当前epoch数)、 `cur_step_num_in_epoch` (当前epoch的step数)、 `cur_step_num` (当前step数)。
2021-11-22 14:54:00 +08:00
2022-07-06 17:30:12 +08:00
参数:
- **step_size** (int, optional) - 定义相邻的 `ds_step_begin`/`ds_step_end` 调用之间相隔的step数默认值1表示每个step都会调用。
2021-11-22 14:54:00 +08:00
.. py:method:: ds_begin(ds_run_context)
用于定义在数据处理管道启动前执行的回调方法。
2022-07-06 17:30:12 +08:00
参数:
- **ds_run_context** (RunContext) - 数据处理管道运行信息。
2021-11-22 14:54:00 +08:00
.. py:method:: ds_epoch_begin(ds_run_context)
用于定义在每个数据epoch开始前执行的回调方法。
2022-07-06 17:30:12 +08:00
参数:
- **ds_run_context** (RunContext) - 数据处理管道运行信息。
2021-11-22 14:54:00 +08:00
.. py:method:: ds_epoch_end(ds_run_context)
用于定义在每个数据epoch结束后执行的回调方法。
2022-07-06 17:30:12 +08:00
参数:
- **ds_run_context** (RunContext) - 数据处理管道运行信息。
2021-11-22 14:54:00 +08:00
.. py:method:: ds_step_begin(ds_run_context)
2022-01-13 11:46:37 +08:00
用于定义在指定数据step开始前执行的回调方法。
2021-11-22 14:54:00 +08:00
2022-07-06 17:30:12 +08:00
参数:
- **ds_run_context** (RunContext) - 数据处理管道运行信息。
2021-11-22 14:54:00 +08:00
.. py:method:: ds_step_end(ds_run_context)
2022-01-21 12:00:58 +08:00
用于定义在指定数据step结束后执行的回调方法。
2021-11-22 14:54:00 +08:00
2022-07-06 17:30:12 +08:00
参数:
- **ds_run_context** (RunContext) - 数据处理管道运行信息。