Skip to content

Commit 32c967b

Browse files
ReganYueLigoml
andauthored
Fix the problem that the parameter content is inconsistent with the source code (#4703)
* Fix the problem that the parameter content is inconsistent with the source code Fix the problem that the parameter content is inconsistent with the source code * Modify the document parameters and add a period to the document. Modify the document parameters and add a period to the document. * fix * fix * fix * fix again * rollback * Update load_cn.rst * Update list_cn.rst * Update help_cn.rst Co-authored-by: Ligoml <[email protected]>
1 parent a07ae52 commit 32c967b

File tree

3 files changed

+22
-33
lines changed

3 files changed

+22
-33
lines changed

docs/api/paddle/hub/help_cn.rst

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,24 @@ help
66
.. py:function:: paddle.hub.help(repo_dir, model, source='github', force_reload=False)
77
88
9-
用于查看repo提供的功能/模型的文档
9+
用于查看repo提供的功能/模型的文档
1010

1111

1212
参数
1313
:::::::::
1414

15-
- **repo_dir** str): repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径
16-
- **model** str):模型的名字
17-
- **source** str | 可选):指定repo托管的位置,支持github和local,默认值:github
18-
- **force_reload** bool | 可选):指定是否强制拉取,默认值False
15+
- **repo_dir** (str) - repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字:repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径
16+
- **model** (str) - 模型的名字
17+
- **source** (str,可选) - 指定repo托管的位置,支持github、gitee和local,默认值:github
18+
- **force_reload** (bool,可选) - 指定是否强制拉取,默认值: False
1919

2020
返回
2121
:::::::::
2222

23-
``str`` ,repo提供的指定模型的文档
23+
``str`` ,repo提供的指定模型的文档
2424

2525

2626
代码示例
2727
:::::::::
2828

29-
.. code-block:: python
30-
31-
import paddle
32-
docs = paddle.hub.help('PaddlePaddle/PaddleClas:develop', 'alexnet', source='github', force_reload=True)
33-
print(docs)
29+
COPY-FROM: paddle.hub.help

docs/api/paddle/hub/list_cn.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,24 @@ list
66
.. py:function:: paddle.hub.list(repo_dir, source='github', force_reload=False)
77
88
9-
用于查看指定repo提供的功能或者模型列表
9+
用于查看指定repo提供的功能或者模型列表
1010

1111

1212
参数
1313
:::::::::
1414

15-
- **repo_dir** (str): repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字:repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径
16-
- **source** (str | 可选):指定repo托管的位置,支持github和local,默认值:github
17-
- **force_reload** (bool | 可选):指定是否强制拉取,默认值:False
15+
- **repo_dir** (str) - repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字:repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径。
16+
- **source** (str,可选) - 指定repo托管的位置,支持github、gitee和local,默认值:github。
17+
- **force_reload** (bool,可选) - 指定是否强制拉取,默认值: False。
18+
1819

1920
返回
2021
:::::::::
2122

22-
``list`` ,repo提供的模型/功能列表
23+
``list`` ,repo提供的模型/功能列表
2324

2425

2526
代码示例
2627
:::::::::
2728

28-
.. code-block:: python
29-
30-
import paddle
31-
models = paddle.hub.list('PaddlePaddle/PaddleClas:develop', source='github', force_reload=True)
32-
print(models)
29+
COPY-FROM: paddle.hub.list

docs/api/paddle/hub/load_cn.rst

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,25 @@ load
55

66
.. py:function:: paddle.hub.load(repo_dir, model, source='github', force_reload=False, **kwargs)
77
8-
用于加载repo提供的功能/模型列表
8+
用于加载repo提供的功能/模型列表
99

1010

1111
参数
1212
:::::::::
1313

14-
- **repo_dir** str): repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径
15-
- **model** str):模型的名字
16-
- **source** str | 可选):指定repo托管的位置,支持github和local,默认值:github
17-
- **force_reload** bool | 可选):指定是否强制拉取,默认值False
18-
- **kwargs** any | 可选):模型参数
14+
- **repo_dir** (str) - repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字:repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径
15+
- **model** (str)- 模型的名字
16+
- **source** (str,可选) - 指定repo托管的位置,支持github、gitee和local,默认值:github
17+
- **force_reload** (bool,可选) - 指定是否强制拉取,默认值: False
18+
- **\*\*kwargs** (any,可选) - 模型参数
1919

2020
返回
2121
:::::::::
2222

23-
``paddle.nn.Layer`` ,repo提供的指定模型实例
23+
``paddle.nn.Layer`` ,repo提供的指定模型实例
2424

2525

2626
代码示例
2727
:::::::::
2828

29-
.. code-block:: python
30-
31-
import paddle
32-
model = paddle.hub.help('PaddlePaddle/PaddleClas:develop', 'alexnet', source='github', force_reload=True)
33-
print(model)
29+
COPY-FROM: paddle.hub.load

0 commit comments

Comments
 (0)