From ef04011885c0fb0abbef345e0154d7ca010a2577 Mon Sep 17 00:00:00 2001 From: huodagu Date: Thu, 8 Sep 2022 18:36:50 +0800 Subject: [PATCH] modify format --- docs/api/api_python/mindarmour.fuzz_testing.rst | 33 +++++++++--------- ...ndarmour.natural_robustness.transform.image.rst | 2 +- .../api_python/mindarmour.privacy.evaluation.rst | 9 ++--- .../api_python/mindarmour.privacy.sup_privacy.rst | 9 ++--- docs/api/api_python/mindarmour.rst | 39 +++++++++++----------- 5 files changed, 48 insertions(+), 44 deletions(-) diff --git a/docs/api/api_python/mindarmour.fuzz_testing.rst b/docs/api/api_python/mindarmour.fuzz_testing.rst index e3c8d57..b97ea0b 100644 --- a/docs/api/api_python/mindarmour.fuzz_testing.rst +++ b/docs/api/api_python/mindarmour.fuzz_testing.rst @@ -18,22 +18,23 @@ mindarmour.fuzz_testing 参数： - **mutate_config** (list) - 变异方法配置。格式为： - .. code-block:: python - - mutate_config = [ - {'method': 'GaussianBlur', - 'params': {'ksize': [1, 2, 3, 5], 'auto_param': [True, False]}}, - {'method': 'UniformNoise', - 'params': {'factor': [0.1, 0.2, 0.3], 'auto_param': [False, True]}}, - {'method': 'GaussianNoise', - 'params': {'factor': [0.1, 0.2, 0.3], 'auto_param': [False, True]}}, - {'method': 'Contrast', - 'params': {'alpha': [0.5, 1, 1.5], 'beta': [-10, 0, 10], 'auto_param': [False, True]}}, - {'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)]}} - ...] + + .. code-block:: python + + mutate_config = [ + {'method': 'GaussianBlur', + 'params': {'ksize': [1, 2, 3, 5], 'auto_param': [True, False]}}, + {'method': 'UniformNoise', + 'params': {'factor': [0.1, 0.2, 0.3], 'auto_param': [False, True]}}, + {'method': 'GaussianNoise', + 'params': {'factor': [0.1, 0.2, 0.3], 'auto_param': [False, True]}}, + {'method': 'Contrast', + 'params': {'alpha': [0.5, 1, 1.5], 'beta': [-10, 0, 10], 'auto_param': [False, True]}}, + {'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)]}} + ...] - 支持的方法在列表 `self._strategies` 中，每个方法的参数必须在可选参数的范围内。支持的方法分为两种类型： - 首先，自然鲁棒性方法包括：'Translate'、'Scale'、'Shear'、'Rotate'、'Perspective'、'Curve'、'GaussianBlur'、'MotionBlur'、'GradientBlur'、'Contrast'、'GradientLuminance'、'UniformNoise'、'GaussianNoise'、'SaltAndPepperNoise'、'NaturalNoise'。 diff --git a/docs/api/api_python/mindarmour.natural_robustness.transform.image.rst b/docs/api/api_python/mindarmour.natural_robustness.transform.image.rst index abc463e..ce8ea6d 100644 --- a/docs/api/api_python/mindarmour.natural_robustness.transform.image.rst +++ b/docs/api/api_python/mindarmour.natural_robustness.transform.image.rst @@ -22,7 +22,7 @@ mindarmour.natural_robustness.transform.image - **start_point** (union[tuple, list]) - 渐变中心的二维坐标。 - **scope** (float) - 渐变的范围。值越大，渐变范围越大。默认值：0.3。 - **pattern** (str) - 深色或浅色，此值必须在['light', 'dark']中。 - - **bright_rate** (float) - 控制亮度。值越大，梯度范围越大。如果参数`pattern`为'light'，建议值范围为[0.1, 0.7]，如果参数`pattern`为'dark'，建议值范围为[0.1, 0.9]。 + - **bright_rate** (float) - 控制亮度。值越大，梯度范围越大。如果参数 `pattern` 为'light'，建议值范围为[0.1, 0.7]，如果参数 `pattern` 为'dark'，建议值范围为[0.1, 0.9]。 - **mode** (str) - 渐变模式，值必须在['circle', 'horizontal', 'vertical']中。 - **auto_param** (bool) - 自动选择参数。在保留图像的语义的范围内自动选择参数。默认值：False。 diff --git a/docs/api/api_python/mindarmour.privacy.evaluation.rst b/docs/api/api_python/mindarmour.privacy.evaluation.rst index 53a2b7a..8c0f2e0 100644 --- a/docs/api/api_python/mindarmour.privacy.evaluation.rst +++ b/docs/api/api_python/mindarmour.privacy.evaluation.rst @@ -41,11 +41,12 @@ 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)}}] + .. code-block:: python + + attack_config = + [{"method": "knn", "params": {"n_neighbors": [3, 5, 7]}}, + {"method": "lr", "params": {"C": np.logspace(-4, 2, 10)}}] - 支持的方法有knn、lr、mlp和rf，每个方法的参数必须在可变参数的范围内。参数实现的提示可在下面找到： diff --git a/docs/api/api_python/mindarmour.privacy.sup_privacy.rst b/docs/api/api_python/mindarmour.privacy.sup_privacy.rst index 25cc3f4..11c526e 100644 --- a/docs/api/api_python/mindarmour.privacy.sup_privacy.rst +++ b/docs/api/api_python/mindarmour.privacy.sup_privacy.rst @@ -25,7 +25,7 @@ mindarmour.privacy.sup_privacy 抑制隐私训练器，重载自 :class:`mindspore.Model` 。 - 有关详细信息，请查看： `应用抑制隐私机制保护用户隐私 `_。 + 有关详细信息，请查看： `应用抑制隐私机制保护用户隐私 `_。 参数： - **network** (Cell) - 要训练的神经网络模型。 @@ -161,10 +161,11 @@ mindarmour.privacy.sup_privacy 参数： - **layer_name** (str) - 层名称，如下获取一个层的名称： - .. code-block:: - for layer in networks.get_parameters(expand=True): - if layer.name == "conv": ... + .. code-block:: + + for layer in networks.get_parameters(expand=True): + if layer.name == "conv": ... - **grad_idx** (int) - 掩码层在梯度元组中的索引。可参考 `model.py `_ 中TrainOneStepCell的构造函数，在PYNATIVE_MODE模式下打印某些层的索引值。 - **is_add_noise** (bool) - 如果为True，则此层的权重可以添加噪声。如果为False，则此层的权重不能添加噪声。如果参数num大于100000，则　`is_add_noise` 无效。 diff --git a/docs/api/api_python/mindarmour.rst b/docs/api/api_python/mindarmour.rst index 1e52b89..56d02fc 100644 --- a/docs/api/api_python/mindarmour.rst +++ b/docs/api/api_python/mindarmour.rst @@ -152,22 +152,23 @@ MindArmour是MindSpore的工具箱，用于增强模型可信，实现隐私保 参数： - **mutate_config** (list) - 变异方法配置。格式为： - .. code-block:: python + + .. code-block:: python - mutate_config = - [{'method': 'GaussianBlur', - 'params': {'ksize': [1, 2, 3, 5], 'auto_param': [True, False]}}, - {'method': 'UniformNoise', - 'params': {'factor': [0.1, 0.2, 0.3], 'auto_param': [False, True]}}, - {'method': 'GaussianNoise', - 'params': {'factor': [0.1, 0.2, 0.3], 'auto_param': [False, True]}}, - {'method': 'Contrast', - 'params': {'alpha': [0.5, 1, 1.5], 'beta': [-10, 0, 10], 'auto_param': [False, True]}}, - {'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)]}}] - ...] + mutate_config = + [{'method': 'GaussianBlur', + 'params': {'ksize': [1, 2, 3, 5], 'auto_param': [True, False]}}, + {'method': 'UniformNoise', + 'params': {'factor': [0.1, 0.2, 0.3], 'auto_param': [False, True]}}, + {'method': 'GaussianNoise', + 'params': {'factor': [0.1, 0.2, 0.3], 'auto_param': [False, True]}}, + {'method': 'Contrast', + 'params': {'alpha': [0.5, 1, 1.5], 'beta': [-10, 0, 10], 'auto_param': [False, True]}}, + {'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)]}}] + ...] - 支持的方法在列表 `self._strategies` 中，每个方法的参数必须在可选参数的范围内。支持的方法分为两种类型： - 首先，自然鲁棒性方法包括：'Translate', 'Scale'、'Shear'、'Rotate'、'Perspective'、'Curve'、'GaussianBlur'、'MotionBlur'、'GradientBlur'、'Contrast'、'GradientLuminance'、'UniformNoise'、'GaussianNoise'、'SaltAndPepperNoise'、'NaturalNoise'。 @@ -252,11 +253,11 @@ MindArmour是MindSpore的工具箱，用于增强模型可信，实现隐私保 - **dataset_test** (minspore.dataset) - 目标模型的测试集。 - **attack_config** (Union[list, tuple]) - 攻击模型的参数设置。格式为： - .. code-block:: + .. code-block:: - attack_config = [ - {"method": "knn", "params": {"n_neighbors": [3, 5, 7]}}, - {"method": "lr", "params": {"C": np.logspace(-4, 2, 10)}}] + attack_config = [ + {"method": "knn", "params": {"n_neighbors": [3, 5, 7]}}, + {"method": "lr", "params": {"C": np.logspace(-4, 2, 10)}}] - 支持的方法有knn、lr、mlp和rf，每个方法的参数必须在可变参数的范围内。参数实现的提示可在下面找到：