From 0ca2f371ba7d90ea7a2170fe2c70b7294361b666 Mon Sep 17 00:00:00 2001 From: huodagu Date: Fri, 16 Sep 2022 11:57:05 +0800 Subject: [PATCH] modify format --- .vscode/settings.json | 3 +++ docs/api/api_python/mindarmour.privacy.diff_privacy.rst | 12 +++++++----- 2 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..a7d0fc7 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "esbonio.sphinx.confDir": "" +} \ No newline at end of file diff --git a/docs/api/api_python/mindarmour.privacy.diff_privacy.rst b/docs/api/api_python/mindarmour.privacy.diff_privacy.rst index e537831..4ead822 100644 --- a/docs/api/api_python/mindarmour.privacy.diff_privacy.rst +++ b/docs/api/api_python/mindarmour.privacy.diff_privacy.rst @@ -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