Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
PEAL
PEAL

User guide

  • Installation
  • How the pieces fit together
  • User guide

Model cards

  • RAE-CLIP ImageNet — representation autoencoder for counterfactual explanation

Development

  • Development

API reference

  • API reference
    • peal.adaptors
      • peal.adaptors.adaptor_factory
        • peal.adaptors.adaptor_factory.get_adaptor
      • peal.adaptors.clarc
        • peal.adaptors.clarc.CavCache
        • peal.adaptors.clarc.calculate_cav
        • peal.adaptors.clarc.calculate_pcav
        • peal.adaptors.clarc.calculate_svm_cav
        • peal.adaptors.clarc.extract_all_children
        • peal.adaptors.clarc.get_layer_name
        • peal.adaptors.clarc.split_model
        • peal.adaptors.clarc.CavCache
        • peal.adaptors.clarc.CavProjection
        • peal.adaptors.clarc.ClArC
        • peal.adaptors.clarc.ClArCConfig
        • peal.adaptors.clarc.PClArC
        • peal.adaptors.clarc.PClArCConfig
        • peal.adaptors.clarc.RRClArC
        • peal.adaptors.clarc.RRClArCConfig
        • peal.adaptors.clarc.SimpleProjection
      • peal.adaptors.counterfactual_knowledge_distillation
        • peal.adaptors.counterfactual_knowledge_distillation.CFKD
        • peal.adaptors.counterfactual_knowledge_distillation.CFKDConfig
      • peal.adaptors.didae
        • peal.adaptors.didae.DiDAE
        • peal.adaptors.didae.DiDAEConfig
        • peal.adaptors.didae.ProbeModel
      • peal.adaptors.group_distributionally_robust_optimization
        • peal.adaptors.group_distributionally_robust_optimization.GroupDRO
        • peal.adaptors.group_distributionally_robust_optimization.GroupDROConfig
      • peal.adaptors.group_dro_v2
        • peal.adaptors.group_dro_v2.compute_group_sizes
        • peal.adaptors.group_dro_v2.GroupDROv2
        • peal.adaptors.group_dro_v2.GroupDROv2Config
        • peal.adaptors.group_dro_v2.GroupDroLossComputer
      • peal.adaptors.interfaces
        • peal.adaptors.interfaces.Adaptor
        • peal.adaptors.interfaces.AdaptorConfig
      • peal.adaptors.projection_adaptor
        • peal.adaptors.projection_adaptor.projection_wrap_model
        • peal.adaptors.projection_adaptor.ProjectionAdaptor
        • peal.adaptors.projection_adaptor.ProjectionAdaptorConfig
    • peal.architectures
      • peal.architectures.basic_modules
        • peal.architectures.basic_modules.DimensionSwitchAttentionLayer
        • peal.architectures.basic_modules.ImgSelfAttentionLayer
        • peal.architectures.basic_modules.Mean
        • peal.architectures.basic_modules.OneHotEncoding
        • peal.architectures.basic_modules.SelfAttentionLayer
        • peal.architectures.basic_modules.SkipConnection
        • peal.architectures.basic_modules.Squeeze
        • peal.architectures.basic_modules.Transpose
        • peal.architectures.basic_modules.Unsqueeze
      • peal.architectures.interfaces
        • peal.architectures.interfaces.ArchitectureConfig
        • peal.architectures.interfaces.FCConfig
        • peal.architectures.interfaces.ResnetConfig
        • peal.architectures.interfaces.TaskConfig
        • peal.architectures.interfaces.TransformerConfig
        • peal.architectures.interfaces.VGGConfig
      • peal.architectures.module_blocks
        • peal.architectures.module_blocks.create_cnn_layer
        • peal.architectures.module_blocks.FCBlock
        • peal.architectures.module_blocks.ResnetBlock
        • peal.architectures.module_blocks.TransformerBlock
        • peal.architectures.module_blocks.VGGBlock
      • peal.architectures.onnx_predictor
        • peal.architectures.onnx_predictor.export_to_onnx
        • peal.architectures.onnx_predictor.find_final_linear
        • peal.architectures.onnx_predictor.inspect_onnx
        • peal.architectures.onnx_predictor.load_onnx_as_torch
        • peal.architectures.onnx_predictor.load_onnx_predictor
        • peal.architectures.onnx_predictor.load_onnx_runtime
        • peal.architectures.onnx_predictor.normalize_onnx_graph
        • peal.architectures.onnx_predictor.select_onnx_outputs
        • peal.architectures.onnx_predictor.truncate_to_features
        • peal.architectures.onnx_predictor.write_final_linear
        • peal.architectures.onnx_predictor.OnnxPredictor
      • peal.architectures.predictors
        • peal.architectures.predictors.get_predictor
        • peal.architectures.predictors.load_model
        • peal.architectures.predictors.SequentialModel
        • peal.architectures.predictors.TorchvisionModel
    • peal.data
      • peal.data.custom_datasets
        • peal.data.custom_datasets.datastr
        • peal.data.custom_datasets.download_celeba_to
        • peal.data.custom_datasets.parse_datastr
        • peal.data.custom_datasets.plot_latents_with_arrows
        • peal.data.custom_datasets.Camelyon17AugmentedDataset
        • peal.data.custom_datasets.Camelyon17Dataset
        • peal.data.custom_datasets.CelebACopyrighttagDataset
        • peal.data.custom_datasets.CelebADataset
        • peal.data.custom_datasets.CelebAHQDataset
        • peal.data.custom_datasets.ColoredMnist
        • peal.data.custom_datasets.ColoredMnistConfig
        • peal.data.custom_datasets.FollicleDataset
        • peal.data.custom_datasets.FunnyNodulesDataset
        • peal.data.custom_datasets.ISICAnnotatedDataset
        • peal.data.custom_datasets.MnistDataset
        • peal.data.custom_datasets.NicoPlusPlusDataset
        • peal.data.custom_datasets.OnlySparseNumbersDataset
        • peal.data.custom_datasets.OnlySparseNumbersZipfDataset
        • peal.data.custom_datasets.RxRx1AugmentedDataset
        • peal.data.custom_datasets.RxRx1Dataset
        • peal.data.custom_datasets.SkinConDataset
        • peal.data.custom_datasets.SparseNumbersDataset
        • peal.data.custom_datasets.SparseNumbersDenseDataset
        • peal.data.custom_datasets.SparseNumbersDenseZipfDataset
        • peal.data.custom_datasets.SparseNumbersZipfDataset
        • peal.data.custom_datasets.SquareDataset
        • peal.data.custom_datasets.WaterbirdsDataset
      • peal.data.dataloaders
        • peal.data.dataloaders.create_class_ordered_batch
        • peal.data.dataloaders.create_dataloaders_from_datasource
        • peal.data.dataloaders.get_dataloader
        • peal.data.dataloaders.resolve_num_workers
        • peal.data.dataloaders.DataIterator
        • peal.data.dataloaders.DataStack
        • peal.data.dataloaders.DataloaderMixer
        • peal.data.dataloaders.WeightedDataloaderList
      • peal.data.dataset_factory
        • peal.data.dataset_factory.get_datasets
      • peal.data.dataset_generators
        • peal.data.dataset_generators.latent_to_square_image
        • peal.data.dataset_generators.ArtificialConfounderSequenceDatasetGenerator
        • peal.data.dataset_generators.ArtificialConfounderTabularDatasetGenerator
        • peal.data.dataset_generators.CircleDatasetGenerator
        • peal.data.dataset_generators.ConfounderDatasetGenerator
        • peal.data.dataset_generators.FunnyNodulesDatasetGenerator
        • peal.data.dataset_generators.MNISTConfounderDatasetGenerator
        • peal.data.dataset_generators.OnlySparseNumbersDatasetGenerator
        • peal.data.dataset_generators.OnlySparseNumbersZipfDatasetGenerator
        • peal.data.dataset_generators.SparseNumbersDatasetGenerator
        • peal.data.dataset_generators.SparseNumbersZipfDatasetGenerator
        • peal.data.dataset_generators.SquareDatasetGenerator
        • peal.data.dataset_generators.StainingConfounderGenerator
      • peal.data.dataset_utils
        • peal.data.dataset_utils.parse_csv
        • peal.data.dataset_utils.parse_json
        • peal.data.dataset_utils.process_confounder_data_controlled
      • peal.data.datasets
        • peal.data.datasets.Image2ClassDataset
        • peal.data.datasets.Image2MixedDataset
        • peal.data.datasets.ImageDataset
        • peal.data.datasets.SymbolicDataset
      • peal.data.interfaces
        • peal.data.interfaces.DataConfig
        • peal.data.interfaces.PealDataset
      • peal.data.tabular_datasets
        • peal.data.tabular_datasets.ADULT_FEATURES
        • peal.data.tabular_datasets.ADULT_RENAME
        • peal.data.tabular_datasets.ADULT_CATEGORIES
        • peal.data.tabular_datasets.curate_adult_frame
        • peal.data.tabular_datasets.decode_adult_codes
        • peal.data.tabular_datasets.setup_kaggle_api
        • peal.data.tabular_datasets.AdultDataset
        • peal.data.tabular_datasets.CircleDataset
        • peal.data.tabular_datasets.CompassDataset
        • peal.data.tabular_datasets.GermanDataset
      • peal.data.transformations
        • peal.data.transformations.CircularCut
        • peal.data.transformations.DiffusionAugmentation
        • peal.data.transformations.IdentityNormalization
        • peal.data.transformations.Normalization
        • peal.data.transformations.Padding
        • peal.data.transformations.RandomResizeCropPad
        • peal.data.transformations.RandomRotation
        • peal.data.transformations.SetChannels
    • peal.editors
      • peal.editors.ddpm_inversion
        • peal.editors.ddpm_inversion.DDPMInversionConfig
      • peal.editors.interfaces
        • peal.editors.interfaces.EditorConfig
    • peal.entrypoints
      • peal.entrypoints.evaluate_predictor
        • peal.entrypoints.evaluate_predictor.main
      • peal.entrypoints.generate_dataset
        • peal.entrypoints.generate_dataset.main
      • peal.entrypoints.preflight
        • peal.entrypoints.preflight.main
        • peal.entrypoints.preflight.report
      • peal.entrypoints.run_adaptor
        • peal.entrypoints.run_adaptor.main
      • peal.entrypoints.run_cfkd
        • peal.entrypoints.run_cfkd.main
      • peal.entrypoints.run_component_analysis
        • peal.entrypoints.run_component_analysis.main
      • peal.entrypoints.run_didae
        • peal.entrypoints.run_didae.main
      • peal.entrypoints.run_explainer
        • peal.entrypoints.run_explainer.main
      • peal.entrypoints.run_sae_analysis
        • peal.entrypoints.run_sae_analysis.main
      • peal.entrypoints.train_distilled_predictor
        • peal.entrypoints.train_distilled_predictor.main
      • peal.entrypoints.train_generator
        • peal.entrypoints.train_generator.main
        • peal.entrypoints.train_generator.str2bool
      • peal.entrypoints.train_predictor
        • peal.entrypoints.train_predictor.main
    • peal.explainers
      • peal.explainers.counterfactual_explainer
        • peal.explainers.counterfactual_explainer.flatten_explanations
        • peal.explainers.counterfactual_explainer.ACEConfig
        • peal.explainers.counterfactual_explainer.CounterfactualExplainer
        • peal.explainers.counterfactual_explainer.DAEdistillConfig
        • peal.explainers.counterfactual_explainer.PerfectFalseCounterfactualConfig
        • peal.explainers.counterfactual_explainer.SCEConfig
        • peal.explainers.counterfactual_explainer.TIMEConfig
      • peal.explainers.explainer_factory
        • peal.explainers.explainer_factory.get_explainer
      • peal.explainers.interfaces
        • peal.explainers.interfaces.ExplainerConfig
        • peal.explainers.interfaces.ExplainerInterface
      • peal.explainers.lrp_explainer
        • peal.explainers.lrp_explainer.LRPExplainer
      • peal.explainers.no_generator_counterfactual_explainers
        • peal.explainers.no_generator_counterfactual_explainers.DiCEExplainer
        • peal.explainers.no_generator_counterfactual_explainers.DiCEExplainerConfig
    • peal.generators
      • peal.generators.ddpm_generator
        • peal.generators.ddpm_generator.load_state_dict
        • peal.generators.ddpm_generator.DDPM
        • peal.generators.ddpm_generator.DDPMConfig
      • peal.generators.deeplift_resnet
        • peal.generators.deeplift_resnet.DeepLiftResNet101
        • peal.generators.deeplift_resnet.DeepLiftResNet152
        • peal.generators.deeplift_resnet.DeepLiftResNet18
        • peal.generators.deeplift_resnet.DeepLiftResNet34
        • peal.generators.deeplift_resnet.DeepLiftResNet50
        • peal.generators.deeplift_resnet.DeepLiftBasicBlock
        • peal.generators.deeplift_resnet.DeepLiftBottleneck
        • peal.generators.deeplift_resnet.DeepLiftResNet
      • peal.generators.generator_factory
        • peal.generators.generator_factory.get_generator
      • peal.generators.interfaces
        • peal.generators.interfaces.EditCapableGenerator
        • peal.generators.interfaces.Generator
        • peal.generators.interfaces.GeneratorConfig
        • peal.generators.interfaces.InvertibleGenerator
      • peal.generators.rae_pipeline
        • peal.generators.rae_pipeline.RAEV2_REPO
        • peal.generators.rae_pipeline.default_raev2_dir
        • peal.generators.rae_pipeline.expand_path
        • peal.generators.rae_pipeline.load_generator_config
        • peal.generators.rae_pipeline.main
        • peal.generators.rae_pipeline.require_raev2
        • peal.generators.rae_pipeline.RAEPipeline
      • peal.generators.tabular_ddpm
        • peal.generators.tabular_ddpm.BasicDiscreteTimeModel
        • peal.generators.tabular_ddpm.PositionalEncoding
        • peal.generators.tabular_ddpm.ScoreNetwork
        • peal.generators.tabular_ddpm.TabularDDPM
        • peal.generators.tabular_ddpm.TabularDDPMConfig
    • peal.sparse_dictionaries
      • peal.sparse_dictionaries.activation_cache
        • peal.sparse_dictionaries.activation_cache.cache_path
        • peal.sparse_dictionaries.activation_cache.enabled
        • peal.sparse_dictionaries.activation_cache.extract
        • peal.sparse_dictionaries.activation_cache.load_or_extract
      • peal.sparse_dictionaries.batch_topk
        • peal.sparse_dictionaries.batch_topk.BatchTopKSAE
        • peal.sparse_dictionaries.batch_topk.BatchTopKSAEConfig
      • peal.sparse_dictionaries.batch_topk_network
        • peal.sparse_dictionaries.batch_topk_network.get_default_cfg
        • peal.sparse_dictionaries.batch_topk_network.train_batch_topk_saes
        • peal.sparse_dictionaries.batch_topk_network.ActivationStore
        • peal.sparse_dictionaries.batch_topk_network.BatchTopKNetwork
        • peal.sparse_dictionaries.batch_topk_network.SparseAutoencoderBase
      • peal.sparse_dictionaries.interfaces
        • peal.sparse_dictionaries.interfaces.SparseDictionary
        • peal.sparse_dictionaries.interfaces.SparseDictionaryConfig
      • peal.sparse_dictionaries.msae_decomposition
        • peal.sparse_dictionaries.msae_decomposition.MSAEDecomposition
        • peal.sparse_dictionaries.msae_decomposition.MSAEDecompositionConfig
      • peal.sparse_dictionaries.orthogonal_procrustes_dictionary
        • peal.sparse_dictionaries.orthogonal_procrustes_dictionary.OrthogonalProcrustesDictionary
        • peal.sparse_dictionaries.orthogonal_procrustes_dictionary.OrthogonalProcrustesDictionaryConfig
      • peal.sparse_dictionaries.probe_sparse_autoencoder
        • peal.sparse_dictionaries.probe_sparse_autoencoder.ProbeSAE
        • peal.sparse_dictionaries.probe_sparse_autoencoder.ProbeSAEConfig
      • peal.sparse_dictionaries.ra_sae_decomposition
        • peal.sparse_dictionaries.ra_sae_decomposition.RASAEDecomposition
        • peal.sparse_dictionaries.ra_sae_decomposition.RASAEDecompositionConfig
      • peal.sparse_dictionaries.sae_evaluation
        • peal.sparse_dictionaries.sae_evaluation.compute_component_f1_scores
        • peal.sparse_dictionaries.sae_evaluation.log_evaluation_to_tensorboard
        • peal.sparse_dictionaries.sae_evaluation.log_evaluation_to_wandb
        • peal.sparse_dictionaries.sae_evaluation.plot_diagonalized_matching_matrix
        • peal.sparse_dictionaries.sae_evaluation.run_sae_eval
      • peal.sparse_dictionaries.singular_value_decomposition
        • peal.sparse_dictionaries.singular_value_decomposition.SVDDictionary
        • peal.sparse_dictionaries.singular_value_decomposition.SVDDictionaryConfig
      • peal.sparse_dictionaries.sparse_dictionary_factory
        • peal.sparse_dictionaries.sparse_dictionary_factory.get_sparse_dictionary
      • peal.sparse_dictionaries.splice_decomposition
        • peal.sparse_dictionaries.splice_decomposition.SpLICEDecomposition
        • peal.sparse_dictionaries.splice_decomposition.SpLICEDecompositionConfig
      • peal.sparse_dictionaries.svd_filtered_sae
        • peal.sparse_dictionaries.svd_filtered_sae.SVDFilteredBatchTopKSAE
        • peal.sparse_dictionaries.svd_filtered_sae.SVDFilteredBatchTopKSAEConfig
        • peal.sparse_dictionaries.svd_filtered_sae.SVDFilteredSAEConfig
      • peal.sparse_dictionaries.utils
        • peal.sparse_dictionaries.utils.plot_component_ground_truth_correlations
        • peal.sparse_dictionaries.utils.read_component_bounds
        • peal.sparse_dictionaries.utils.select_dictionary_components
    • peal.teachers
      • peal.teachers.baseline_teacher
        • peal.teachers.baseline_teacher.BaselineTeacher
      • peal.teachers.cluster_teacher
        • peal.teachers.cluster_teacher.ClusterTeacher
        • peal.teachers.cluster_teacher.DataStore
      • peal.teachers.human2model_teacher
        • peal.teachers.human2model_teacher.DataStore
        • peal.teachers.human2model_teacher.Human2ModelTeacher
      • peal.teachers.interfaces
        • peal.teachers.interfaces.TeacherInterface
      • peal.teachers.llm2model_teacher
        • peal.teachers.llm2model_teacher.LLM2ModelTeacher
      • peal.teachers.model2model_teacher
        • peal.teachers.model2model_teacher.Model2ModelTeacher
        • peal.teachers.model2model_teacher.NoisyModel2ModelTeacher
      • peal.teachers.preclustered_teacher
        • peal.teachers.preclustered_teacher.PreclusteredTeacher
      • peal.teachers.segmentation_mask_teacher
        • peal.teachers.segmentation_mask_teacher.SegmentationMaskTeacher
      • peal.teachers.spray_teacher
        • peal.teachers.spray_teacher.append_attributions
        • peal.teachers.spray_teacher.append_inputs
        • peal.teachers.spray_teacher.create_attribution_database
        • peal.teachers.spray_teacher.create_input_database
        • peal.teachers.spray_teacher.resize_attribution_db
        • peal.teachers.spray_teacher.resize_input_db
        • peal.teachers.spray_teacher.Flatten
        • peal.teachers.spray_teacher.LogitDifference
        • peal.teachers.spray_teacher.Normalize
        • peal.teachers.spray_teacher.Spray
        • peal.teachers.spray_teacher.SprayConfig
        • peal.teachers.spray_teacher.SumChannel
      • peal.teachers.symbolic_teacher
        • peal.teachers.symbolic_teacher.SymbolicTeacher
      • peal.teachers.teacher_factory
        • peal.teachers.teacher_factory.get_teacher
      • peal.teachers.virelay_teacher
        • peal.teachers.virelay_teacher.append_attributions
        • peal.teachers.virelay_teacher.create_attribution_database
        • peal.teachers.virelay_teacher.create_attribution_dataset
        • peal.teachers.virelay_teacher.create_dataset
        • peal.teachers.virelay_teacher.make_project
        • peal.teachers.virelay_teacher.meta_analysis
        • peal.teachers.virelay_teacher.run_virelay
        • peal.teachers.virelay_teacher.Absolute
        • peal.teachers.virelay_teacher.Flatten
        • peal.teachers.virelay_teacher.Histogram
        • peal.teachers.virelay_teacher.ImageDataset
        • peal.teachers.virelay_teacher.Normalize
        • peal.teachers.virelay_teacher.SumChannel
        • peal.teachers.virelay_teacher.VirelayTeacher
      • peal.teachers.web_feedback_teacher
        • peal.teachers.web_feedback_teacher.WebFeedbackTeacher
    • peal.training
      • peal.training.criterions
        • peal.training.criterions.cross_entropy_criterion
        • peal.training.criterions.cross_entropy_loss
        • peal.training.criterions.focal_criterion
        • peal.training.criterions.get_criterions
        • peal.training.criterions.l1_criterion
        • peal.training.criterions.l2_criterion
        • peal.training.criterions.latent_convexity_criterion
        • peal.training.criterions.mixed_bce_mse_criterion
        • peal.training.criterions.mixed_focal_mse_criterion
        • peal.training.criterions.orthogonality_criterion
        • peal.training.criterions.FocalLoss
        • peal.training.criterions.OnehotCrossEntropyLoss
      • peal.training.interfaces
        • peal.training.interfaces.PredictorConfig
        • peal.training.interfaces.TrainingConfig
      • peal.training.loggers
        • peal.training.loggers.log_images_to_writer
        • peal.training.loggers.Logger
      • peal.training.trainers
        • peal.training.trainers.calculate_test_accuracy
        • peal.training.trainers.distill_1ofn_dataset
        • peal.training.trainers.distill_binary_dataset
        • peal.training.trainers.distill_dataloader_mixer
        • peal.training.trainers.distill_predictor
        • peal.training.trainers.get_predictor
        • peal.training.trainers.load_first_loadable
        • peal.training.trainers.mixup
        • peal.training.trainers.ModelTrainer
      • peal.training.training_utils
        • peal.training.training_utils.calculate_validation_statistics
    • peal.visualization
      • peal.visualization.create_didae_table1
        • peal.visualization.create_didae_table1.create_table
        • peal.visualization.create_didae_table1.format_table
        • peal.visualization.create_didae_table1.get_scalar
      • peal.visualization.image_grid
        • peal.visualization.image_grid.bool_list_to_checkboxes
        • peal.visualization.image_grid.embed_text_in_image
        • peal.visualization.image_grid.make_column
        • peal.visualization.image_grid.make_image_grid
        • peal.visualization.image_grid.zip_tensors
      • peal.visualization.model_comparison
        • peal.visualization.model_comparison.change_all
        • peal.visualization.model_comparison.create_checkbox_dict
        • peal.visualization.model_comparison.create_comparison
        • peal.visualization.model_comparison.get_explanation
      • peal.visualization.visualize_counterfactual_gradients
        • peal.visualization.visualize_counterfactual_gradients.create_label_image
    • peal.web
      • peal.web.analysis
        • peal.web.analysis.CLIP_MEAN
        • peal.web.analysis.analyse
        • peal.web.analysis.direction_atoms
        • peal.web.analysis.group_accuracies
        • peal.web.analysis.quick_accuracy
      • peal.web.app
        • peal.web.app.MAX_RENDER_DIRECTIONS
        • peal.web.app.PAIR_COLLAGE_RE
        • peal.web.app.create_app
        • peal.web.app.group_by_direction
        • peal.web.app.pretty_direction_name
      • peal.web.cache
        • peal.web.cache.CLIP_MEAN
        • peal.web.cache.build
        • peal.web.cache.cache_path
        • peal.web.cache.final_layer
        • peal.web.cache.load
      • peal.web.config_builder
        • peal.web.config_builder.build_job_configs
        • peal.web.config_builder.resolve_normalization
      • peal.web.dfr
        • peal.web.dfr.C_GRID
        • peal.web.dfr.CF_WEIGHT
        • peal.web.dfr.correct
      • peal.web.ingest
        • peal.web.ingest.build_pair_dataset
        • peal.web.ingest.discover_classes
        • peal.web.ingest.ingest_zip
        • peal.web.ingest.safe_extract
        • peal.web.ingest.IngestError
      • peal.web.jobs
        • peal.web.jobs.STEP_RE
        • peal.web.jobs.STEP_ORDER
        • peal.web.jobs.latest_activity
        • peal.web.jobs.pending_feedback_round
        • peal.web.jobs.JobStore
        • peal.web.jobs.Worker
      • peal.web.paths
        • peal.web.paths.get_project_resource_dir
      • peal.web.summarize
        • peal.web.summarize.summarize
    • peal.global_utils
      • peal.global_utils.add_class_arguments
      • peal.global_utils.cprint
      • peal.global_utils.dict_to_bar_chart
      • peal.global_utils.embed_numberstring
      • peal.global_utils.extract_penultima_activation
      • peal.global_utils.find_subclasses
      • peal.global_utils.generate_feature_similarity_overlay
      • peal.global_utils.generate_overlay
      • peal.global_utils.generate_ssim_overlay
      • peal.global_utils.get_config_model
      • peal.global_utils.get_intermediate_output
      • peal.global_utils.get_predictions
      • peal.global_utils.get_project_resource_dir
      • peal.global_utils.high_contrast_heatmap
      • peal.global_utils.integrate_argument
      • peal.global_utils.integrate_arguments
      • peal.global_utils.is_port_in_use
      • peal.global_utils.load_yaml_config
      • peal.global_utils.move_to_device
      • peal.global_utils.onehot
      • peal.global_utils.orthogonal_initialization
      • peal.global_utils.propagate_seed
      • peal.global_utils.replace_relu_with_leakyrelu
      • peal.global_utils.replace_relu_with_leakysoftplus
      • peal.global_utils.request
      • peal.global_utils.requires_grad_
      • peal.global_utils.reset_weights
      • peal.global_utils.save_yaml_config
      • peal.global_utils.set_adaptive_batch_size
      • peal.global_utils.set_random_seed
      • peal.global_utils.ssim_map
      • peal.global_utils.DINOEvaluator
      • peal.global_utils.LeakySoftplus
    • peal.preflight
      • peal.preflight.INPUT_KEYS
      • peal.preflight.NESTED_PATH_KEYS
      • peal.preflight.OUTPUT_KEYS
      • peal.preflight.CHECKPOINT_SUFFIXES
      • peal.preflight.WEIGHT_SUFFIXES
      • peal.preflight.PERSONAL_PREFIXES
      • peal.preflight.check_config
      • peal.preflight.check_script
      • peal.preflight.check_script_executables
      • peal.preflight.configs_in_script
      • peal.preflight.expand
      • peal.preflight.is_personal
      • peal.preflight.produced_by
      • peal.preflight.project_root
      • peal.preflight.scripts_invoked_by
Back to top
View this page
Edit this page

peal.adaptors.clarc.calculate_cav¶

peal.adaptors.clarc.calculate_cav(activations, annotations, projection_type)[source]¶

Dispatch to calculate_pcav() or calculate_svm_cav().

Parameters:
  • activations (torch.Tensor) – Shape (N, D).

  • annotations (torch.Tensor) – Shape (N,) with 0 / 1 artifact labels.

  • projection_type (str) – "pcav" or "svm".

Returns:

Unit-norm CAV of shape (1, D) (pcav) or (D,) (svm).

Return type:

torch.Tensor

Raises:

NotImplementedError – For other projection types.

Next
peal.adaptors.clarc.calculate_pcav
Previous
peal.adaptors.clarc.CavCache
Copyright © 2023-2026, Sidney Bender and the PEAL contributors
Made with Sphinx and @pradyunsg's Furo
On this page
  • peal.adaptors.clarc.calculate_cav
    • calculate_cav()