Nigel
/
mindspore
forked from mindspore-Ecosystem/mindspore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

!28008 [docs]modify docs of jvp and vjp 

Merge pull request !28008 from chenzhuo/master
This commit is contained in:
i-robot 2021-12-22 06:25:05 +00:00 committed by Gitee
parent 5cd53b2eed 8b9100354f
commit 21c83445f4
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api/api_python/nn/mindspore.nn.Jvp.rst
View File

@ -3,20 +3,20 @@ mindspore.nn.Jvp
.. py:class:: mindspore.nn.Jvp(fn)
计算给定网络的雅可比向量积(Jacobian-vector product, JVP)。JVP对应前向模式自动微分。
计算给定网络的雅可比向量积(Jacobian-vector product, JVP)。JVP对应 `前向模式自动微分 <https://mindspore.cn/docs/programming_guide/zh-CN/master/design/gradient.html#id3>`_。
**参数：**
- **fn** (Cell) - 基于Cell的网络，用于接收张量输入并返回张量或者张量元组。
- **fn** (Cell) - 基于Cell的网络，用于接收Tensor输入并返回Tensor或者Tensor元组。
**输入：**
- **inputs** (Tensor) - 输入网络的入参，单个或多个张量。
- **v** (Tensor or Tuple of Tensor) - 与雅可比矩阵点乘的向量，形状与网络的输入一致。
- **inputs** (Tensor) - 输入网络的入参，单个或多个Tensor。
- **v** (Tensor or Tuple of Tensor) - 与雅可比矩阵点乘的向量，Shape与网络的输入一致。
**输出：**
2个张量或张量元组构成的元组。
2个Tensor或Tensor元组构成的元组。
- **net_output** (Tensor or Tuple of Tensor) - 输入网络的正向计算结果。
- **jvp** (Tensor or Tuple of Tensor) - 雅可比向量积的结果。

10
docs/api/api_python/nn/mindspore.nn.Vjp.rst
View File

@ -3,20 +3,20 @@ mindspore.nn.Vjp
.. py:class:: mindspore.nn.Vjp(fn)
计算给定网络的向量雅可比积(vector-Jacobian product, VJP)。VJP对应反向模式自动微分。
计算给定网络的向量雅可比积(vector-Jacobian product, VJP)。VJP对应 `反向模式自动微分 <https://mindspore.cn/docs/programming_guide/zh-CN/master/design/gradient.html#id4>`_。
**参数：**
- **fn** (Cell) - 基于Cell的网络，用于接收张量输入并返回张量或者张量元组。
- **fn** (Cell) - 基于Cell的网络，用于接收Tensor输入并返回Tensor或者Tensor元组。
**输入：**
- **inputs** (Tensor) - 输入网络的入参，单个或多个张量。
- **v** (Tensor or Tuple of Tensor) - 与雅可比矩阵点乘的向量，形状与网络的输出一致。
- **inputs** (Tensor) - 输入网络的入参，单个或多个Tensor。
- **v** (Tensor or Tuple of Tensor) - 与雅可比矩阵点乘的向量，Shape与网络的输出一致。
**输出：**
2个张量或张量元组构成的元组。
2个Tensor或Tensor元组构成的元组。
- **net_output** (Tensor or Tuple of Tensor) - 输入网络的正向计算结果。
- **vjp** (Tensor or Tuple of Tensor) - 向量雅可比积的结果。