Browse Source

!401 modify the format of API files

Merge pull request !401 from 宦晓玲/master
pull/400/MERGE
i-robot Gitee 2 years ago
parent
commit
213a6afb47
No known key found for this signature in database GPG Key ID: 173E9B9CA92EEF8F
4 changed files with 14 additions and 9 deletions
  1. +5
    -4
      docs/api/api_python/mindarmour.fuzz_testing.rst
  2. +2
    -1
      docs/api/api_python/mindarmour.privacy.evaluation.rst
  3. +1
    -0
      docs/api/api_python/mindarmour.privacy.sup_privacy.rst
  4. +6
    -4
      docs/api/api_python/mindarmour.rst

+ 5
- 4
docs/api/api_python/mindarmour.fuzz_testing.rst View File

@@ -17,10 +17,11 @@ mindarmour.fuzz_testing
深度神经网络的模糊测试。

参数:
- **mutate_config** (list) - 变异方法配置。格式为:
- **mutate_config** (list) - 变异方法配置。格式为:

.. code-block:: python

mutate_config =
mutate_config = [
{'method': 'GaussianBlur',
'params': {'ksize': [1, 2, 3, 5], 'auto_param': [True, False]}},
{'method': 'UniformNoise',
@@ -32,11 +33,11 @@ mindarmour.fuzz_testing
{'method': 'Rotate',
'params': {'angle': [20, 90], 'auto_param': [False, True]}},
{'method': 'FGSM',
'params': {'eps': [0.3, 0.2, 0.4], 'alpha': [0.1], 'bounds': [(0, 1)]}}]
'params': {'eps': [0.3, 0.2, 0.4], 'alpha': [0.1], 'bounds': [(0, 1)]}}
...]

- 支持的方法在列表 `self._strategies` 中,每个方法的参数必须在可选参数的范围内。支持的方法分为两种类型:
- 首先,自然鲁棒性方法包括:'Translate', 'Scale'、'Shear'、'Rotate'、'Perspective'、'Curve'、'GaussianBlur'、'MotionBlur'、'GradientBlur'、'Contrast'、'GradientLuminance'、'UniformNoise'、'GaussianNoise'、'SaltAndPepperNoise'、'NaturalNoise'。
- 首先,自然鲁棒性方法包括:'Translate''Scale'、'Shear'、'Rotate'、'Perspective'、'Curve'、'GaussianBlur'、'MotionBlur'、'GradientBlur'、'Contrast'、'GradientLuminance'、'UniformNoise'、'GaussianNoise'、'SaltAndPepperNoise'、'NaturalNoise'。
- 其次,对抗样本攻击方式包括:'FGSM'、'PGD'和'MDIM'。'FGSM'、'PGD'和'MDIM'分别是 FastGradientSignMethod、ProjectedGradientDent和MomentumDiverseInputIterativeMethod的缩写。 `mutate_config` 必须包含在['Contrast', 'GradientLuminance', 'GaussianBlur', 'MotionBlur', 'GradientBlur', 'UniformNoise', 'GaussianNoise', 'SaltAndPepperNoise', 'NaturalNoise']中的方法。

- 第一类方法的参数设置方式可以在'mindarmour/natural_robustness/transform/image'中看到。第二类方法参数配置参考 `self._attack_param_checklists` 。


+ 2
- 1
docs/api/api_python/mindarmour.privacy.evaluation.rst View File

@@ -41,8 +41,9 @@ mindarmour.privacy.evaluation
- **dataset_train** (minspore.dataset) - 目标模型的训练数据集。
- **dataset_test** (minspore.dataset) - 目标模型的测试集。
- **attack_config** (Union[list, tuple]) - 攻击模型的参数设置。格式为

.. code-block:: python
attack_config =
[{"method": "knn", "params": {"n_neighbors": [3, 5, 7]}},
{"method": "lr", "params": {"C": np.logspace(-4, 2, 10)}}]


+ 1
- 0
docs/api/api_python/mindarmour.privacy.sup_privacy.rst View File

@@ -161,6 +161,7 @@ mindarmour.privacy.sup_privacy

参数:
- **layer_name** (str) - 层名称,如下获取一个层的名称:

.. code-block::

for layer in networks.get_parameters(expand=True):


+ 6
- 4
docs/api/api_python/mindarmour.rst View File

@@ -151,7 +151,8 @@ MindArmour是MindSpore的工具箱,用于增强模型可信,实现隐私保
深度神经网络的模糊测试。

参数:
- **mutate_config** (list) - 变异方法配置。格式为:
- **mutate_config** (list) - 变异方法配置。格式为:

.. code-block:: python
mutate_config =
@@ -250,11 +251,12 @@ MindArmour是MindSpore的工具箱,用于增强模型可信,实现隐私保
参数:
- **dataset_train** (minspore.dataset) - 目标模型的训练数据集。
- **dataset_test** (minspore.dataset) - 目标模型的测试集。
- **attack_config** (Union[list, tuple]) - 攻击模型的参数设置。格式为:
- **attack_config** (Union[list, tuple]) - 攻击模型的参数设置。格式为:

.. code-block::

attack_config =
[{"method": "knn", "params": {"n_neighbors": [3, 5, 7]}},
attack_config = [
{"method": "knn", "params": {"n_neighbors": [3, 5, 7]}},
{"method": "lr", "params": {"C": np.logspace(-4, 2, 10)}}]

- 支持的方法有knn、lr、mlp和rf,每个方法的参数必须在可变参数的范围内。参数实现的提示可在下面找到:


Loading…
Cancel
Save