diff --git a/docs/api/api_python/mindarmour.fuzz_testing.rst b/docs/api/api_python/mindarmour.fuzz_testing.rst index d7f2236..09b2351 100644 --- a/docs/api/api_python/mindarmour.fuzz_testing.rst +++ b/docs/api/api_python/mindarmour.fuzz_testing.rst @@ -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` 。 diff --git a/docs/api/api_python/mindarmour.privacy.evaluation.rst b/docs/api/api_python/mindarmour.privacy.evaluation.rst index 36b8c60..e2c409e 100644 --- a/docs/api/api_python/mindarmour.privacy.evaluation.rst +++ b/docs/api/api_python/mindarmour.privacy.evaluation.rst @@ -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)}}] diff --git a/docs/api/api_python/mindarmour.privacy.sup_privacy.rst b/docs/api/api_python/mindarmour.privacy.sup_privacy.rst index 25cc3f4..b1919e6 100644 --- a/docs/api/api_python/mindarmour.privacy.sup_privacy.rst +++ b/docs/api/api_python/mindarmour.privacy.sup_privacy.rst @@ -161,6 +161,7 @@ mindarmour.privacy.sup_privacy 参数: - **layer_name** (str) - 层名称,如下获取一个层的名称: + .. code-block:: for layer in networks.get_parameters(expand=True): diff --git a/docs/api/api_python/mindarmour.rst b/docs/api/api_python/mindarmour.rst index b33d58d..65b1f15 100644 --- a/docs/api/api_python/mindarmour.rst +++ b/docs/api/api_python/mindarmour.rst @@ -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,每个方法的参数必须在可变参数的范围内。参数实现的提示可在下面找到: