From b3254e36ce5908f601cb08d76063e61aac833769 Mon Sep 17 00:00:00 2001 From: zhangting2020 Date: Wed, 27 Apr 2022 04:17:26 +0000 Subject: [PATCH 1/5] add autotune.set_config api doc --- .../incubate/autotune/set_config_cn.rst | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/api/paddle/incubate/autotune/set_config_cn.rst diff --git a/docs/api/paddle/incubate/autotune/set_config_cn.rst b/docs/api/paddle/incubate/autotune/set_config_cn.rst new file mode 100644 index 00000000000..7dd5cfb9bf2 --- /dev/null +++ b/docs/api/paddle/incubate/autotune/set_config_cn.rst @@ -0,0 +1,30 @@ +.. _cn_api_incubate_autotune_set_config: + +set_config +--------------------- + +.. py:function:: paddle.incubate.autotune.set_config(config=None) +配置kernel、layout和dataloader的自动调优功能。 + +1. kernel：当开启自动调优，将使用穷举搜索的方法在调优的迭代区间内为算子选择最佳算法，并将其缓存下来。调优参数如下： + + - **enable** (bool) - 是否开启kernel的调优功能。默认值：False。 + - **tuning_range** (list) - 自动调优开始和结束的迭代序号。默认值：[1, 10]。 + +2. layout：当开启自动调优，将根据设备和数据类型确定最优的数据布局如NCHW或者NHWC。当原始的layout设置并非最优时，将会自动进行layout的转换已提升模型的性能。调优参数如下： + + - **enable** (bool) - 是否开启layout的调优功能。默认值：False。 + +3. dataloader：当开启自动调优，将自动选择最佳的num_workers替换原始的配置。调优参数如下： + + - **enable** (bool) - 是否开启dataloader的调优功能。默认值：False。 + +参数 +::::::::: + + - **config** (dict|str|None，可选) - 自动调整的配置。如果它是字典，则键是调优类型，值是调优参数构成的字典。如果它是字符串，则表示json文件路径，将根据json 文件内容配置调优参数。默认值：None，使用默认配置。 + +代码示例 +:::::::::: + +COPY-FROM: paddle.incubate.autotune.set_config:auto-tuning \ No newline at end of file From 544cb9f149c6d5dfa0adadc1248bf0c1511027e0 Mon Sep 17 00:00:00 2001 From: Zhang Ting Date: Wed, 27 Apr 2022 14:47:14 +0800 Subject: [PATCH 2/5] Update set_config_cn.rst fix typo --- docs/api/paddle/incubate/autotune/set_config_cn.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/incubate/autotune/set_config_cn.rst b/docs/api/paddle/incubate/autotune/set_config_cn.rst index 7dd5cfb9bf2..e2bc77ccf8e 100644 --- a/docs/api/paddle/incubate/autotune/set_config_cn.rst +++ b/docs/api/paddle/incubate/autotune/set_config_cn.rst @@ -11,7 +11,7 @@ set_config - **enable** (bool) - 是否开启kernel的调优功能。默认值：False。 - **tuning_range** (list) - 自动调优开始和结束的迭代序号。默认值：[1, 10]。 -2. layout：当开启自动调优，将根据设备和数据类型确定最优的数据布局如NCHW或者NHWC。当原始的layout设置并非最优时，将会自动进行layout的转换已提升模型的性能。调优参数如下： +2. layout：当开启自动调优，将根据设备和数据类型确定最优的数据布局如NCHW或者NHWC。当原始的layout设置并非最优时，将会自动进行layout的转换以提升模型的性能。调优参数如下： - **enable** (bool) - 是否开启layout的调优功能。默认值：False。 @@ -27,4 +27,4 @@ set_config 代码示例 :::::::::: -COPY-FROM: paddle.incubate.autotune.set_config:auto-tuning \ No newline at end of file +COPY-FROM: paddle.incubate.autotune.set_config:auto-tuning From 362d60e48c94426c5b4ad4cede969ad08bc41fe1 Mon Sep 17 00:00:00 2001 From: Zhang Ting Date: Wed, 27 Apr 2022 15:28:01 +0800 Subject: [PATCH 3/5] Update set_config_cn.rst --- docs/api/paddle/incubate/autotune/set_config_cn.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/api/paddle/incubate/autotune/set_config_cn.rst b/docs/api/paddle/incubate/autotune/set_config_cn.rst index e2bc77ccf8e..64f4f7c3eb6 100644 --- a/docs/api/paddle/incubate/autotune/set_config_cn.rst +++ b/docs/api/paddle/incubate/autotune/set_config_cn.rst @@ -4,25 +4,26 @@ set_config --------------------- .. py:function:: paddle.incubate.autotune.set_config(config=None) + 配置kernel、layout和dataloader的自动调优功能。 1. kernel：当开启自动调优，将使用穷举搜索的方法在调优的迭代区间内为算子选择最佳算法，并将其缓存下来。调优参数如下： - - **enable** (bool) - 是否开启kernel的调优功能。默认值：False。 + - **enable** (bool) - 是否开启kernel的调优功能。 - **tuning_range** (list) - 自动调优开始和结束的迭代序号。默认值：[1, 10]。 2. layout：当开启自动调优，将根据设备和数据类型确定最优的数据布局如NCHW或者NHWC。当原始的layout设置并非最优时，将会自动进行layout的转换以提升模型的性能。调优参数如下： - - **enable** (bool) - 是否开启layout的调优功能。默认值：False。 + - **enable** (bool) - 是否开启layout的调优功能。 3. dataloader：当开启自动调优，将自动选择最佳的num_workers替换原始的配置。调优参数如下： - - **enable** (bool) - 是否开启dataloader的调优功能。默认值：False。 + - **enable** (bool) - 是否开启dataloader的调优功能。 参数 ::::::::: - - **config** (dict|str|None，可选) - 自动调整的配置。如果它是字典，则键是调优类型，值是调优参数构成的字典。如果它是字符串，则表示json文件路径，将根据json 文件内容配置调优参数。默认值：None，使用默认配置。 + - **config** (dict|str|None，可选) - 自动调整的配置。如果它是字典，则键是调优类型，值是调优参数构成的字典。如果它是字符串，则表示json文件路径，将根据json 文件内容配置调优参数。默认值：None，kernel、layout和dataloader的自动调优功能将全被开启。 代码示例 :::::::::: From bcad0a9911cc0dff838f06ce02f02f433b50d0f5 Mon Sep 17 00:00:00 2001 From: Zhang Ting Date: Wed, 27 Apr 2022 16:26:03 +0800 Subject: [PATCH 4/5] Update set_config_cn.rst --- docs/api/paddle/incubate/autotune/set_config_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/incubate/autotune/set_config_cn.rst b/docs/api/paddle/incubate/autotune/set_config_cn.rst index 64f4f7c3eb6..295247c6934 100644 --- a/docs/api/paddle/incubate/autotune/set_config_cn.rst +++ b/docs/api/paddle/incubate/autotune/set_config_cn.rst @@ -12,7 +12,7 @@ set_config - **enable** (bool) - 是否开启kernel的调优功能。 - **tuning_range** (list) - 自动调优开始和结束的迭代序号。默认值：[1, 10]。 -2. layout：当开启自动调优，将根据设备和数据类型确定最优的数据布局如NCHW或者NHWC。当原始的layout设置并非最优时，将会自动进行layout的转换以提升模型的性能。调优参数如下： +2. layout：当开启自动调优，将根据设备和数据类型确定最优的数据布局如NCHW或者NHWC。当原始的layout设置并非最优时，将会自动进行layout的转换以提升模型的性能。该功能当前仅支持动态图模式。调优参数如下： - **enable** (bool) - 是否开启layout的调优功能。 From 84887c5654f46fb05ea4cc4a2779c0cacb83661c Mon Sep 17 00:00:00 2001 From: Zhang Ting Date: Thu, 28 Apr 2022 20:30:31 +0800 Subject: [PATCH 5/5] Update set_config_cn.rst --- docs/api/paddle/incubate/autotune/set_config_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/incubate/autotune/set_config_cn.rst b/docs/api/paddle/incubate/autotune/set_config_cn.rst index 295247c6934..45d7abdd8a2 100644 --- a/docs/api/paddle/incubate/autotune/set_config_cn.rst +++ b/docs/api/paddle/incubate/autotune/set_config_cn.rst @@ -12,7 +12,7 @@ set_config - **enable** (bool) - 是否开启kernel的调优功能。 - **tuning_range** (list) - 自动调优开始和结束的迭代序号。默认值：[1, 10]。 -2. layout：当开启自动调优，将根据设备和数据类型确定最优的数据布局如NCHW或者NHWC。当原始的layout设置并非最优时，将会自动进行layout的转换以提升模型的性能。该功能当前仅支持动态图模式。调优参数如下： +2. layout：当开启自动调优，将根据设备和数据类型确定最优的数据布局如NCHW或者NHWC。当原始的layout设置并非最优时，将会自动进行layout的转换以提升模型的性能。**该功能当前仅支持动态图模式**。调优参数如下： - **enable** (bool) - 是否开启layout的调优功能。