diff --git a/docs/api/paddle/hub/help_cn.rst b/docs/api/paddle/hub/help_cn.rst index 7654ec3011e..e82b1831cf4 100644 --- a/docs/api/paddle/hub/help_cn.rst +++ b/docs/api/paddle/hub/help_cn.rst @@ -6,28 +6,24 @@ help .. py:function:: paddle.hub.help(repo_dir, model, source='github', force_reload=False) -用于查看repo提供的功能/模型的文档 +用于查看repo提供的功能/模型的文档。 参数 ::::::::: - - **repo_dir** (str): repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字:repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径 - - **model** (str):模型的名字 - - **source** (str | 可选):指定repo托管的位置,支持github和local,默认值:github - - **force_reload** (bool | 可选):指定是否强制拉取,默认值:False + - **repo_dir** (str) - repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字:repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径。 + - **model** (str) - 模型的名字。 + - **source** (str,可选) - 指定repo托管的位置,支持github、gitee和local,默认值:github。 + - **force_reload** (bool,可选) - 指定是否强制拉取,默认值: False。 返回 ::::::::: - ``str`` ,repo提供的指定模型的文档 + ``str`` ,repo提供的指定模型的文档。 代码示例 ::::::::: -.. code-block:: python - - import paddle - docs = paddle.hub.help('PaddlePaddle/PaddleClas:develop', 'alexnet', source='github', force_reload=True) - print(docs) +COPY-FROM: paddle.hub.help diff --git a/docs/api/paddle/hub/list_cn.rst b/docs/api/paddle/hub/list_cn.rst index e80d10f6c4d..e304b9a2338 100644 --- a/docs/api/paddle/hub/list_cn.rst +++ b/docs/api/paddle/hub/list_cn.rst @@ -6,27 +6,24 @@ list .. py:function:: paddle.hub.list(repo_dir, source='github', force_reload=False) -用于查看指定repo提供的功能或者模型列表 +用于查看指定repo提供的功能或者模型列表。 参数 ::::::::: - - **repo_dir** (str): repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字:repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径 - - **source** (str | 可选):指定repo托管的位置,支持github和local,默认值:github - - **force_reload** (bool | 可选):指定是否强制拉取,默认值:False + - **repo_dir** (str) - repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字:repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径。 + - **source** (str,可选) - 指定repo托管的位置,支持github、gitee和local,默认值:github。 + - **force_reload** (bool,可选) - 指定是否强制拉取,默认值: False。 + 返回 ::::::::: - ``list`` ,repo提供的模型/功能列表 + ``list`` ,repo提供的模型/功能列表。 代码示例 ::::::::: -.. code-block:: python - - import paddle - models = paddle.hub.list('PaddlePaddle/PaddleClas:develop', source='github', force_reload=True) - print(models) +COPY-FROM: paddle.hub.list diff --git a/docs/api/paddle/hub/load_cn.rst b/docs/api/paddle/hub/load_cn.rst index 48647dd63de..32ab26ce9f3 100644 --- a/docs/api/paddle/hub/load_cn.rst +++ b/docs/api/paddle/hub/load_cn.rst @@ -5,29 +5,25 @@ load .. py:function:: paddle.hub.load(repo_dir, model, source='github', force_reload=False, **kwargs) -用于加载repo提供的功能/模型列表 +用于加载repo提供的功能/模型列表。 参数 ::::::::: - - **repo_dir** (str): repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字:repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径 - - **model** (str):模型的名字 - - **source** (str | 可选):指定repo托管的位置,支持github和local,默认值:github - - **force_reload** (bool | 可选):指定是否强制拉取,默认值:False - - **kwargs** (any | 可选):模型参数 + - **repo_dir** (str) - repo地址,支持git地址形式和local地址。git地址由repo拥有者/repo名字:repo分支组成,实例:PaddlePaddle/PaddleClas:develop;local地址为repo的本地路径。 + - **model** (str)- 模型的名字。 + - **source** (str,可选) - 指定repo托管的位置,支持github、gitee和local,默认值:github。 + - **force_reload** (bool,可选) - 指定是否强制拉取,默认值: False。 + - **\*\*kwargs** (any,可选) - 模型参数。 返回 ::::::::: - ``paddle.nn.Layer`` ,repo提供的指定模型实例 + ``paddle.nn.Layer`` ,repo提供的指定模型实例。 代码示例 ::::::::: -.. code-block:: python - - import paddle - model = paddle.hub.help('PaddlePaddle/PaddleClas:develop', 'alexnet', source='github', force_reload=True) - print(model) +COPY-FROM: paddle.hub.load