未验证 提交 2fee5ee9 编写于 作者: L lanxianghit 提交者: GitHub

add Chinese doc of required_version (#1771)

Add Chinese doc of required_version, corresponding to Eng version: https://www.paddlepaddle.org.cn/documentation/docs/en/api/fluid/require_version.html#require-version
上级 91607e08
.. _cn_api_fluid_require_version:
require_version
-------------------------------
.. py:function:: paddle.fluid.require_version(min_version, max_version=None)
该接口用于检查已安装的飞桨版本是否介于[``min_version``, ``max_version``]之间(包含 ``min_version`` 和 ``max_version`` ),如果已安装的版本低于 ``min_version`` 或者高于 ``max_version`` ,将会抛出异常。该接口无返回值。
参数:
- **min_version** (str) - 指定所需要的最低版本(如‘1.4.0’)
- **max_version** (str, optional) – 指定可接受的最高版本(如‘1.7.0’),默认值None,表示任意大于等于 ``min_version`` 的版本都可以接受。
返回:无
抛出异常:
- ``TypeError`` – ``min_version`` 的类型不是str。
- ``TypeError`` – ``max_version`` 的类型不是str或type(None)。
- ``ValueError`` – ``min_version`` 的值不是正常的版本号格式。
- ``ValueError`` – ``max_version`` 的值不是正常的版本号格式或None。
- ``Exception`` – 已安装的版本低于 ``min_version`` 或者高于 ``max_version`` 。
**代码示例**:
.. code-block:: python
import paddle.fluid as fluid
# 任何大于等于0.1.0的版本都可以接受
fluid.require_version('0.1.0')
# 只接受介于0.1.0和10.0.0之间的版本(包含0.1.0和10.0.0)
fluid.require_version(min_version='0.1.0', max_version='10.0.0')
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册