CLI Package

---

• cli.commands package
  • cli.commands.attack package
    • cli.commands.attack.commands module
      • common_attack_options()
  • cli.commands.defense package
    • cli.commands.defense.commands module
  • cli.commands.evaluation package
    • cli.commands.evaluation.adversarial package
      • cli.commands.evaluation.adversarial.commands module
    • cli.commands.evaluation.commands module
  • cli.commands.train package
    • cli.commands.train.commands module
      • IntListParamType
        • IntListParamType.convert()
        • IntListParamType.name
  • cli.commands.utils package
    • cli.commands.utils.configs package
      • cli.commands.utils.configs.commands module
    • cli.commands.utils.models package
      • cli.commands.utils.models.commands module
    • cli.commands.utils.normalization package
      • cli.commands.utils.normalization.commands module
    • cli.commands.utils.weights package
      • cli.commands.utils.weights.commands module
    • cli.commands.utils.commands module
• cli.configs package
  • cli.configs.attacks package
    • cli.configs.attacks.base package
    • cli.configs.attacks.shared package
  • cli.configs.defenses package
  • cli.configs.evaluation package
  • cli.configs.shared package
  • cli.configs.train_test package
• cli.logic package
  • cli.logic.attack package
    • cli.logic.attack.attack module
      • cli_attack()
    • cli.logic.attack.attacker module
      • CLIAttacker
        • CLIAttacker.execute()
  • cli.logic.defense package
    • cli.logic.defense.adversarial_training package
      • cli.logic.defense.adversarial_training.adversarial_training_cli module
        • ATCLITrainer
          • ATCLITrainer.train()
    • cli.logic.defense.defense module
      • cli_adversarial_training()
  • cli.logic.evaluation package
    • cli.logic.evaluation.adversarial_evaluation package
      • cli.logic.evaluation.adversarial_evaluation.adversarial_evaluator module
        • CLIAdversarialEvaluator
          • CLIAdversarialEvaluator.run()
    • cli.logic.evaluation.test package
      • cli.logic.evaluation.test.test module
        • cli_test()
      • cli.logic.evaluation.test.tester module
        • CLITester
          • CLITester.config
          • CLITester.test()
    • cli.logic.evaluation.evaluation module
      • cli_adversarial_evaluation()
      • cli_list_adversarial_evaluations()
  • cli.logic.train package
    • cli.logic.train.train module
      • cli_train()
    • cli.logic.train.trainer module
      • CLITrainer
        • CLITrainer.config
        • CLITrainer.train()
  • cli.logic.utils package
    • cli.logic.utils.config module
      • cli_config_default()
      • cli_configs()
    • cli.logic.utils.model module
      • cli_available_weights()
      • cli_download_weights()
      • cli_model_layers()
      • cli_models()
    • cli.logic.utils.normalization_params module
      • cli_normalization_params()
• cli.shared package
  • cli.shared.messages package
    • cli.shared.messages.errors module
      • CLIErrorMessages
        • CLIErrorMessages.TRAINER
      • CLITrainerErrorMessages
        • CLITrainerErrorMessages.NORM_LAYER_LENGTH_MISMATCH_MEAN_AND_NUM_INPUT_CHANNELS
        • CLITrainerErrorMessages.NORM_LAYER_LENGTH_MISMATCH_MEAN_AND_STD
        • CLITrainerErrorMessages.NORM_LAYER_LENGTH_MISMATCH_STD_AND_NUM_INPUT_CHANNELS
        • CLITrainerErrorMessages.NORM_LAYER_MEAN_OR_STD_NOT_LIST
        • CLITrainerErrorMessages.NORM_LAYER_MISSING_MEAN_OR_STD
    • cli.shared.messages.infos module
    • cli.shared.messages.warnings module
  • cli.shared.types package
    • cli.shared.types.attack package
      • cli.shared.types.attack.attacks package
        • cli.shared.types.attack.attacks.cw module
          • CwAttackCLIConfigType
        • cli.shared.types.attack.attacks.decision_boundary module
          • DecisionBoundaryAttackCLIConfigType
        • cli.shared.types.attack.attacks.deepfool module
          • DeepFoolAttackCLIConfigType
        • cli.shared.types.attack.attacks.fgsm module
          • FgsmAttackCLIConfigType
        • cli.shared.types.attack.attacks.lots module
          • LotsAttackCLIConfigType
        • cli.shared.types.attack.attacks.pgd module
          • PgdAttackCLIConfigType
      • cli.shared.types.attack.attack module
        • AttackCLIConfigType
          • AttackCLIConfigType.attack_parameters
        • AttackProcedureCliConfigType
          • AttackProcedureCliConfigType.result_images_dir
          • AttackProcedureCliConfigType.result_images_prefix
          • AttackProcedureCliConfigType.save_result_images
          • AttackProcedureCliConfigType.verbose
        • AttackWithNameConfigDict
          • AttackWithNameConfigDict.config
          • AttackWithNameConfigDict.name
        • BaseAttackCLIConfigType
          • BaseAttackCLIConfigType.attack_config
          • BaseAttackCLIConfigType.attack_procedure
          • BaseAttackCLIConfigType.dataloader
          • BaseAttackCLIConfigType.dataset
          • BaseAttackCLIConfigType.device
          • BaseAttackCLIConfigType.model
        • TargetedAttackCLIConfigType
          • TargetedAttackCLIConfigType.target_parameters
    • cli.shared.types.defense package
      • cli.shared.types.defense.adversarial_training module
        • ATCliConfigType
          • ATCliConfigType.adversarial_training
          • ATCliConfigType.training
        • AdversarialTrainingConfig
          • AdversarialTrainingConfig.attacks
          • AdversarialTrainingConfig.models
        • ModelWithConfigDict
          • ModelWithConfigDict.config
    • cli.shared.types.evaluation package
      • cli.shared.types.evaluation.evaluation module
        • AdversarialEvaluationCliConfigType
          • AdversarialEvaluationCliConfigType.evaluation_config
        • AdversarialEvaluationConfigType
          • AdversarialEvaluationConfigType.attack
          • AdversarialEvaluationConfigType.evaluators
          • AdversarialEvaluationConfigType.target_models
      • cli.shared.types.evaluation.testing module
        • Testing
          • Testing.criterion
          • Testing.topk
        • TestingCliConfigType
          • TestingCliConfigType.dataloader
          • TestingCliConfigType.dataset
          • TestingCliConfigType.device
          • TestingCliConfigType.model
          • TestingCliConfigType.testing
    • cli.shared.types.train package
      • cli.shared.types.train.training module
        • Training
          • Training.checkpoint_interval
          • Training.criterion
          • Training.epochs
          • Training.learning_rate
          • Training.load_checkpoint
          • Training.load_checkpoint_path
          • Training.optimizer
          • Training.optimizer_kwargs
          • Training.save_checkpoint
          • Training.save_checkpoint_name
          • Training.save_checkpoint_path
          • Training.save_final_model
          • Training.save_model_name
          • Training.save_model_path
          • Training.scheduler
          • Training.scheduler_kwargs
          • Training.verbose
        • TrainingCliConfigType
          • TrainingCliConfigType.dataloader
          • TrainingCliConfigType.dataset
          • TrainingCliConfigType.device
          • TrainingCliConfigType.model
          • TrainingCliConfigType.training
    • cli.shared.types.utils package
      • cli.shared.types.utils.dataloader module
        • DataLoaderCliConfigType
          • DataLoaderCliConfigType.default
          • DataLoaderCliConfigType.test
          • DataLoaderCliConfigType.train
        • DataLoaderConfig
          • DataLoaderConfig.batch_size
          • DataLoaderConfig.drop_last
          • DataLoaderConfig.num_workers
          • DataLoaderConfig.pin_memory
          • DataLoaderConfig.shuffle
      • cli.shared.types.utils.dataset module
        • AttacksDatasetCliConfigType
          • AttacksDatasetCliConfigType.dataset_part
          • AttacksDatasetCliConfigType.random_sample_size
          • AttacksDatasetCliConfigType.dataset_part
          • AttacksDatasetCliConfigType.random_sample_size
        • DatasetCliConfigType
          • DatasetCliConfigType.dataset_name
          • DatasetCliConfigType.download
          • DatasetCliConfigType.num_classes
          • DatasetCliConfigType.preprocessing
          • DatasetCliConfigType.test_dataset_path
          • DatasetCliConfigType.train_dataset_path
      • cli.shared.types.utils.device module
        • DeviceConfig
          • DeviceConfig.gpu_ids
          • DeviceConfig.processor
          • DeviceConfig.use_ddp
      • cli.shared.types.utils.model module
        • ModelCliConfigType
          • ModelCliConfigType.is_external
          • ModelCliConfigType.model_name
          • ModelCliConfigType.norm_config
          • ModelCliConfigType.num_classes
          • ModelCliConfigType.num_input_channels
          • ModelCliConfigType.path_configs
          • ModelCliConfigType.pretrained
          • ModelCliConfigType.random_seed
          • ModelCliConfigType.weights
        • ModelNormConfig
          • ModelNormConfig.add_norm_layer
          • ModelNormConfig.norm_mean
          • ModelNormConfig.norm_std
        • ModelPathConfig
          • ModelPathConfig.model_arch_path
          • ModelPathConfig.model_weights_path
      • cli.shared.types.utils.target module
        • TargetCLIConfigType
          • TargetCLIConfigType.auto_generate_target
          • TargetCLIConfigType.target_images_config
          • TargetCLIConfigType.target_labels_config
          • TargetCLIConfigType.targeted
        • TargetImageCLIConfigType
          • TargetImageCLIConfigType.target_images_dir
        • TargetLabelCLIConfigType
          • TargetLabelCLIConfigType.target_labels
          • TargetLabelCLIConfigType.target_labels_path
          • TargetLabelCLIConfigType.target_labels_separator
  • cli.shared.utils package
    • cli.shared.utils.attack_mappings module
    • cli.shared.utils.config module
      • attack_config_check()
      • build_config()
      • deep_update()
      • generate_default_config_yaml()
      • get_available_configs()
      • get_default_config_yml()
      • is_path_to_update()
      • load_and_instantiate_config()
      • load_configuration()
      • make_paths_absolute()
      • read_yml_file()
      • update_dict_paths()
      • update_list_paths()
    • cli.shared.utils.dataloader module
      • get_dataloader()
    • cli.shared.utils.dataset module
      • get_datasets()
    • cli.shared.utils.helpers module
      • get_device_from_cfg()
      • read_data_from_file()
      • save_images()
      • to_bchw_format()
    • cli.shared.utils.model module
      • create_model()

---