Browse Source

!414 modify format

Merge pull request !414 from 俞涵/master
pull/415/MERGE
i-robot Gitee 2 years ago
parent
commit
2fe31b9655
No known key found for this signature in database GPG Key ID: 173E9B9CA92EEF8F
2 changed files with 10 additions and 5 deletions
  1. +3
    -0
      .vscode/settings.json
  2. +7
    -5
      docs/api/api_python/mindarmour.privacy.diff_privacy.rst

+ 3
- 0
.vscode/settings.json View File

@@ -0,0 +1,3 @@
{
"esbonio.sphinx.confDir": ""
}

+ 7
- 5
docs/api/api_python/mindarmour.privacy.diff_privacy.rst View File

@@ -91,12 +91,12 @@ mindarmour.privacy.diff_privacy
- **noise_decay_rate** (float) - 控制噪声衰减的超参数。默认值:6e-6。 - **noise_decay_rate** (float) - 控制噪声衰减的超参数。默认值:6e-6。
- **decay_policy** (str) - 衰减策略。如果decay_policy为None,则不需要更新参数。默认值:None。 - **decay_policy** (str) - 衰减策略。如果decay_policy为None,则不需要更新参数。默认值:None。


异常:
- **NameError** - `mech_name` 必须在['Gaussian', 'AdaGaussian']中。

返回: 返回:
- **Mechanisms** - 产生的噪声类别机制。 - **Mechanisms** - 产生的噪声类别机制。


异常:
- **NameError** - `mech_name` 必须在['Gaussian', 'AdaGaussian']中。

.. py:class:: mindarmour.privacy.diff_privacy.ClipMechanismsFactory .. py:class:: mindarmour.privacy.diff_privacy.ClipMechanismsFactory


梯度剪裁机制的工厂类。它目前支持高斯随机噪声(Gaussian Random Noise)的自适应剪裁(Adaptive Clipping)。 梯度剪裁机制的工厂类。它目前支持高斯随机噪声(Gaussian Random Noise)的自适应剪裁(Adaptive Clipping)。
@@ -113,11 +113,13 @@ mindarmour.privacy.diff_privacy
- **fraction_stddev** (float) - 高斯正态的stddev,用于empirical_fraction,公式为 :math:`empirical\_fraction + N(0, fraction\_stddev)` 。默认值:0.01。 - **fraction_stddev** (float) - 高斯正态的stddev,用于empirical_fraction,公式为 :math:`empirical\_fraction + N(0, fraction\_stddev)` 。默认值:0.01。
- **seed** (int) - 原始随机种子,如果seed=0随机正态将使用安全随机数。如果seed!=0随机正态将使用给定的种子生成值。默认值:0。 - **seed** (int) - 原始随机种子,如果seed=0随机正态将使用安全随机数。如果seed!=0随机正态将使用给定的种子生成值。默认值:0。


返回:
- **Mechanisms** - 产生的噪声类别机制。

异常: 异常:
- **NameError** - `mech_name` 必须在['Gaussian']中。 - **NameError** - `mech_name` 必须在['Gaussian']中。


返回:
- **Mechanisms** - 产生的噪声类别机制。


.. py:class:: mindarmour.privacy.diff_privacy.PrivacyMonitorFactory .. py:class:: mindarmour.privacy.diff_privacy.PrivacyMonitorFactory




Loading…
Cancel
Save