From 2734fb35355ac88198ec70938c62d77b39b9030e Mon Sep 17 00:00:00 2001 From: zhangyi Date: Thu, 9 Jun 2022 11:29:08 +0800 Subject: [PATCH] modify the files --- .../api_python/mindarmour.privacy.diff_privacy.rst | 19 +++++++------------ docs/api/api_python/mindarmour.privacy.evaluation.rst | 1 - .../api/api_python/mindarmour.privacy.sup_privacy.rst | 3 +-- docs/api/api_python/mindarmour.utils.rst | 6 +++--- 4 files changed, 11 insertions(+), 18 deletions(-) diff --git a/docs/api/api_python/mindarmour.privacy.diff_privacy.rst b/docs/api/api_python/mindarmour.privacy.diff_privacy.rst index 2d13271..c0d6da4 100644 --- a/docs/api/api_python/mindarmour.privacy.diff_privacy.rst +++ b/docs/api/api_python/mindarmour.privacy.diff_privacy.rst @@ -71,7 +71,7 @@ mindarmour.privacy.diff_privacy - **Tensor** - 更新后的梯度裁剪阈值。 - .. py:method:: AdaClippingWithGaussianRandom.construct(empirical_fraction, norm_bound) + .. py:method:: construct(empirical_fraction, norm_bound) 更新norm_bound的值。 @@ -86,9 +86,7 @@ mindarmour.privacy.diff_privacy .. py:class:: mindarmour.privacy.diff_privacy.NoiseMechanismsFactory - 噪声机制的工厂类 - - 噪声产生机制的包装器。它目前支持高斯随机噪声（Gaussian Random Noise）和自适应高斯随机噪声（Adaptive Gaussian Random Noise）。 + 噪声产生机制的工厂类。它目前支持高斯随机噪声（Gaussian Random Noise）和自适应高斯随机噪声（Adaptive Gaussian Random Noise）。 详情请查看： `教程 `_。 @@ -113,12 +111,11 @@ mindarmour.privacy.diff_privacy .. py:class:: mindarmour.privacy.diff_privacy.ClipMechanismsFactory - 剪裁机制的工厂类 - 噪声生成机制的裁剪包装器。它目前支持高斯随机噪声（Gaussian Random Noise）的自适应剪裁（Adaptive Clipping）。 + 梯度剪裁机制的工厂类。它目前支持高斯随机噪声（Gaussian Random Noise）的自适应剪裁（Adaptive Clipping）。 详情请查看： `教程 `_。 - .. py:method:: ClipMechanismsFactory.create(mech_name, decay_policy='Linear', learning_rate=0.001, target_unclipped_quantile=0.9, fraction_stddev=0.01, seed=0) + .. py:method:: create(mech_name, decay_policy='Linear', learning_rate=0.001, target_unclipped_quantile=0.9, fraction_stddev=0.01, seed=0) **参数：** @@ -143,15 +140,15 @@ mindarmour.privacy.diff_privacy 详情请查看： `教程 `_。 - .. py:method:: PrivacyMonitorFactory.create(policy, *args, **kwargs) + .. py:method:: create(policy, *args, **kwargs) 创建隐私预算监测类。 **参数：** - **policy** (str) - 监控策略，现支持'rdp'和'zcdp'。 - - 如果策略为'rdp'，监控器将根据Renyi差分隐私（Renyi differential privacy，RDP）理论计算DP训练的隐私预算； - - 如果策略为'zcdp'，监控器将根据零集中差分隐私（zero-concentrated differential privacy，zCDP）理论计算DP训练的隐私预算。注意，'zcdp'不适合子采样噪声机制。 + - 如果策略为'rdp'，监控器将根据Renyi差分隐私（Renyi differential privacy，RDP）理论计算DP训练的隐私预算； + - 如果策略为'zcdp'，监控器将根据零集中差分隐私（zero-concentrated differential privacy，zCDP）理论计算DP训练的隐私预算。注意，'zcdp'不适合子采样噪声机制。 - **args** (Union[int, float, numpy.ndarray, list, str]) - 用于创建隐私监视器的参数。 - **kwargs** (Union[int, float, numpy.ndarray, list, str]) - 用于创建隐私监视器的关键字参数。 @@ -201,8 +198,6 @@ mindarmour.privacy.diff_privacy - **run_context** (RunContext) - 包含模型的一些信息。 - - .. py:class:: mindarmour.privacy.diff_privacy.ZCDPMonitor(num_samples, batch_size, initial_noise_multiplier=1.5, max_eps=10.0, target_delta=0.001, noise_decay_mode='Time', noise_decay_rate=0.0006, per_print_times=50, dataset_sink_mode=False) 基于零集中差分隐私（zCDP）理论，计算DP训练的隐私预算。根据下面的参考文献，如果随机化机制满足ρ-zCDP机制，它也满足传统的差分隐私（ε, δ），如下所示： diff --git a/docs/api/api_python/mindarmour.privacy.evaluation.rst b/docs/api/api_python/mindarmour.privacy.evaluation.rst index 52152c5..1c3aaee 100644 --- a/docs/api/api_python/mindarmour.privacy.evaluation.rst +++ b/docs/api/api_python/mindarmour.privacy.evaluation.rst @@ -23,7 +23,6 @@ mindarmour.privacy.evaluation - **TypeError** - n_jobs的类型不是int。 - **ValueError** - n_jobs的值既不是-1，也不是正整数。 - .. py:method:: eval(dataset_train, dataset_test, metrics) 评估目标模型的隐私泄露程度。 diff --git a/docs/api/api_python/mindarmour.privacy.sup_privacy.rst b/docs/api/api_python/mindarmour.privacy.sup_privacy.rst index eacab67..f2b8f29 100644 --- a/docs/api/api_python/mindarmour.privacy.sup_privacy.rst +++ b/docs/api/api_python/mindarmour.privacy.sup_privacy.rst @@ -123,7 +123,6 @@ mindarmour.privacy.sup_privacy 将用于加法运算的掩码数组设置为0。 - .. py:method:: update_mask(networks, cur_step, target_sparse=0.0) 对整个模型的用于加法运算和乘法运算的掩码数组进行更新。 @@ -150,7 +149,7 @@ mindarmour.privacy.sup_privacy 对单层的用于加法运算和乘法运算的掩码数组进行更新。 - 禁用clipping lower、clipping、adding noise操作 + 禁用clipping lower、clipping、adding noise操作。 **参数：** diff --git a/docs/api/api_python/mindarmour.utils.rst b/docs/api/api_python/mindarmour.utils.rst index e82de81..188c589 100644 --- a/docs/api/api_python/mindarmour.utils.rst +++ b/docs/api/api_python/mindarmour.utils.rst @@ -1,7 +1,7 @@ mindarmour.utils ================ -MindArmour的工具方法，包含日志记录和网络包装。 +MindArmour的工具方法。 .. py:class:: mindarmour.utils.LogUtil @@ -119,8 +119,8 @@ MindArmour的工具方法，包含日志记录和网络包装。 **参数：** - **data** (Tensor) - 数据由输入和权重组成。 - - **inputs** - 网络的输入。 - - **weight** - 每个梯度的权重，'weight'与'inputs'的维度相同。 + - inputs: 网络的输入。 + - weight: 每个梯度的权重，'weight'与'labels'的shape相同。 **返回：**