modify format

This commit is contained in:
huodagu
2022-09-16 11:57:05 +08:00
parent d0ae82e8b1
commit 0ca2f371ba
2 changed files with 10 additions and 5 deletions

3
.vscode/settings.json vendored Normal file
View File

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

View File

@@ -91,12 +91,12 @@ mindarmour.privacy.diff_privacy
- **noise_decay_rate** (float) - 控制噪声衰减的超参数。默认值6e-6。
- **decay_policy** (str) - 衰减策略。如果decay_policy为None则不需要更新参数。默认值None。
异常:
- **NameError** - `mech_name` 必须在['Gaussian', 'AdaGaussian']中。
返回:
- **Mechanisms** - 产生的噪声类别机制。
异常:
- **NameError** - `mech_name` 必须在['Gaussian', 'AdaGaussian']中。
.. py:class:: mindarmour.privacy.diff_privacy.ClipMechanismsFactory
梯度剪裁机制的工厂类。它目前支持高斯随机噪声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。
- **seed** (int) - 原始随机种子如果seed=0随机正态将使用安全随机数。如果seed!=0随机正态将使用给定的种子生成值。默认值0。
返回:
- **Mechanisms** - 产生的噪声类别机制。
异常:
- **NameError** - `mech_name` 必须在['Gaussian']中。
返回:
- **Mechanisms** - 产生的噪声类别机制。
.. py:class:: mindarmour.privacy.diff_privacy.PrivacyMonitorFactory