Index

A

abs_attribution (xai4tsc.evaluation.timefrequency_auc.TimeFrequencyAUCEvaluator attribute) add_file_log() (in module xai4tsc.logging_config)

add_relevance() (in module xai4tsc.utils.plot) animate() (xai4tsc.evaluation.frequency_evaluate.PerturbationEvaluator method)

B

baseline (xai4tsc.xai.feature_attribution.OcclusionExplainer attribute) baseline_replacement() (in module xai4tsc.utils.perturbation) BASELINES (in module xai4tsc.utils.perturbation) batch_size (xai4tsc.xai.freqrise.FreqRISEExplainer attribute)

best_epoch (xai4tsc.models.base.ModelBase attribute) blocks (xai4tsc.models.models.ResNet attribute) (xai4tsc.models.models.XLSTM attribute) build_explainer() (in module xai4tsc.xai.explain)

C

cache_dir (xai4tsc.data.datasets.SyntheticDataset attribute) (xai4tsc.data.datasets.UcrUeaDataset attribute) cache_subdir() (xai4tsc.data.datasets.SyntheticDataset method) centroid (xai4tsc.xai.feature_attribution.TSHAPExplainer attribute) channel_mode (xai4tsc.xai.feature_attribution.TSHAPExplainer attribute) class_freqs (xai4tsc.data.datasets.FreqShapesDataset attribute)

classifier (xai4tsc.models.models.FCN attribute) (xai4tsc.models.models.LeNet attribute) (xai4tsc.models.models.LSTM attribute) (xai4tsc.models.models.ResNet attribute) config_resolve() (in module experiment_runner.config) config_sanity_check() (in module experiment_runner.config) count_params() (xai4tsc.models.base.ModelBase method)

D

data_applicability (xai4tsc.evaluation.base.EvaluatorBase attribute) (xai4tsc.evaluation.frequency_evaluate.PerturbationEvaluator attribute) (xai4tsc.evaluation.timefrequency_auc.TimeFrequencyAUCEvaluator attribute) (xai4tsc.xai.base.ExplainerBase attribute) (xai4tsc.xai.base.WrapperExplainer attribute) (xai4tsc.xai.explanation_domains.FrequencyExplainer attribute) (xai4tsc.xai.explanation_domains.TimeFrequencyExplainer attribute) (xai4tsc.xai.feature_attribution.DeconvolutionExplainer attribute) (xai4tsc.xai.feature_attribution.DeepLiftExplainer attribute) (xai4tsc.xai.feature_attribution.GuidedBackpropagationExplainer attribute) (xai4tsc.xai.feature_attribution.IntegratedGradientsExplainer attribute) (xai4tsc.xai.feature_attribution.OcclusionExplainer attribute) (xai4tsc.xai.feature_attribution.TSHAPExplainer attribute) (xai4tsc.xai.freqrise.FreqRISEExplainer attribute) (xai4tsc.xai.random_baseline.RandomFrequencyExplainer attribute) (xai4tsc.xai.random_baseline.RandomTimeFreqExplainer attribute)

data_format (xai4tsc.data.datasets.LocalDataset attribute) DatasetBase (class in xai4tsc.data.base) DeconvolutionExplainer (class in xai4tsc.xai.feature_attribution) DeepLiftExplainer (class in xai4tsc.xai.feature_attribution) device (xai4tsc.models.base.ModelBase attribute) dict_to_args() (in module xai4tsc.utils.utils) disable_logging() (in module xai4tsc.logging_config) domain (xai4tsc.xai.freqrise.FreqRISEExplainer attribute) DomainTransform (class in xai4tsc.utils.fourier_transforms) download (xai4tsc.data.datasets.UcrUeaDataset attribute)

E

embed (xai4tsc.models.models.XLSTM attribute) enable_logging() (in module xai4tsc.logging_config) encoder (xai4tsc.models.models.PatchTST attribute) ensure_datasets_cached() (in module experiment_runner.download_datasets) eval_metric_defaults (in module xai4tsc.utils.defaults) evaluate() (in module xai4tsc.evaluation.evaluate) (xai4tsc.evaluation.base.EvaluatorBase method) (xai4tsc.evaluation.base.QuantusEvaluator method) (xai4tsc.evaluation.frequency_evaluate.PerturbationEvaluator method) (xai4tsc.evaluation.timefrequency_auc.TimeFrequencyAUCEvaluator method) evaluate_model() (xai4tsc.models.base.ModelBase method) EvaluatorBase (class in xai4tsc.evaluation.base) expand_datasets() (in module experiment_runner.main) experiment_runner module experiment_runner.cache module experiment_runner.config module experiment_runner.download_datasets module experiment_runner.evaluate module experiment_runner.explain module experiment_runner.log_setup module

experiment_runner.main module explain() (xai4tsc.xai.base.ExplainerBase method) (xai4tsc.xai.base.GradientExplainer method) (xai4tsc.xai.explanation_domains.FrequencyExplainer method) (xai4tsc.xai.explanation_domains.TimeFrequencyExplainer method) (xai4tsc.xai.feature_attribution.OcclusionExplainer method) (xai4tsc.xai.feature_attribution.TSHAPExplainer method) (xai4tsc.xai.freqrise.FreqRISEExplainer method) (xai4tsc.xai.random_baseline.RandomFrequencyExplainer method) (xai4tsc.xai.random_baseline.RandomTimeFreqExplainer method) (xai4tsc.xai.wrappers.SignExplainer method) ExplainerBase (class in xai4tsc.xai.base) EXPLAINERS (in module xai4tsc.xai.explain) explanation_domains (xai4tsc.xai.base.ExplainerBase attribute) (xai4tsc.xai.base.WrapperExplainer attribute) (xai4tsc.xai.explanation_domains.FrequencyExplainer attribute) (xai4tsc.xai.explanation_domains.TimeFrequencyExplainer attribute) (xai4tsc.xai.freqrise.FreqRISEExplainer attribute) (xai4tsc.xai.random_baseline.RandomFrequencyExplainer attribute) (xai4tsc.xai.random_baseline.RandomTimeFreqExplainer attribute) explanation_type (xai4tsc.xai.base.ExplainerBase attribute) (xai4tsc.xai.base.GradientExplainer attribute) (xai4tsc.xai.base.PerturbationExplainer attribute) (xai4tsc.xai.base.SurrogateExplainer attribute) (xai4tsc.xai.base.WrapperExplainer attribute) (xai4tsc.xai.feature_attribution.TSHAPExplainer attribute)

F

FCN (class in xai4tsc.models.models) features (xai4tsc.models.models.FCN attribute) (xai4tsc.models.models.LeNet attribute) features_in_step (xai4tsc.evaluation.frequency_evaluate.PerturbationEvaluator attribute) file_log() (in module xai4tsc.logging_config) fit() (xai4tsc.data.base.MultiHotLabelEncoder method) fit_transform() (xai4tsc.data.base.MultiHotLabelEncoder method) FORMAT_LOADERS (in module xai4tsc.data.data_loaders) forward() (xai4tsc.models.base.ModelBase method) (xai4tsc.models.models.FCN method) (xai4tsc.models.models.LeNet method) (xai4tsc.models.models.LSTM method) (xai4tsc.models.models.PatchTST method) (xai4tsc.models.models.ResNet method) (xai4tsc.models.models.XLSTM method) (xai4tsc.utils.fourier_transforms.DomainTransform method) (xai4tsc.utils.fourier_transforms.FourierTransform method) (xai4tsc.utils.fourier_transforms.RFFTransform method) (xai4tsc.utils.fourier_transforms.STFTransform method)

FourierTransform (class in xai4tsc.utils.fourier_transforms) FreqRISEExplainer (class in xai4tsc.xai.freqrise) FreqShapesDataset (class in xai4tsc.data.datasets) FrequencyEvaluator (class in xai4tsc.evaluation.frequency_evaluate) FrequencyExplainer (class in xai4tsc.xai.explanation_domains) FrequencyPerturbationAnimation (class in xai4tsc.utils.animation)

G

gap (xai4tsc.models.models.FCN attribute) (xai4tsc.models.models.ResNet attribute) generate_dataset() (xai4tsc.data.datasets.FreqShapesDataset method) (xai4tsc.data.datasets.SyntheticDataset method) generate_explanation() (in module xai4tsc.xai.explain)

get_dataset_cache_dir() (in module experiment_runner.cache) get_split_cache_path() (in module experiment_runner.cache) get_splits() (xai4tsc.data.base.DatasetBase method) get_transform() (in module xai4tsc.utils.fourier_transforms) GradientExplainer (class in xai4tsc.xai.base) GuidedBackpropagationExplainer (class in xai4tsc.xai.feature_attribution)

H

head (xai4tsc.models.models.PatchTST attribute) (xai4tsc.models.models.XLSTM attribute)

hop_length (xai4tsc.utils.fourier_transforms.STFTransform attribute)

I

initial_setup() (in module experiment_runner.main) IntegratedGradientsExplainer (class in xai4tsc.xai.feature_attribution) inverse() (xai4tsc.utils.fourier_transforms.DomainTransform method) (xai4tsc.utils.fourier_transforms.FourierTransform method) (xai4tsc.utils.fourier_transforms.RFFTransform method) (xai4tsc.utils.fourier_transforms.STFTransform method)

inverse_transform() (xai4tsc.data.base.MultiHotLabelEncoder method) is_raw_layout() (xai4tsc.data.datasets.SyntheticDataset static method) is_split_layout() (xai4tsc.data.datasets.SyntheticDataset static method)

L

LeNet (class in xai4tsc.models.models) length (xai4tsc.data.datasets.FreqShapesDataset attribute) load() (xai4tsc.data.base.DatasetBase method) (xai4tsc.data.datasets.LocalDataset method) (xai4tsc.data.datasets.SyntheticDataset method) (xai4tsc.data.datasets.UcrUeaDataset method) load_class_from_path() (in module xai4tsc.utils.utils) load_dataset() (in module xai4tsc.data.datasets) load_ext_model() (in module xai4tsc.models.models) load_from_checkpoint() (xai4tsc.models.base.ModelBase class method) load_json() (in module xai4tsc.data.data_loaders) load_metadata() (in module xai4tsc.data.data_loaders) load_model() (in module xai4tsc.models.models) load_saved_splits() (xai4tsc.data.base.DatasetBase method) LocalDataset (class in xai4tsc.data.datasets) logger (in module experiment_runner.config) (in module experiment_runner.download_datasets) (in module experiment_runner.evaluate) (in module experiment_runner.explain) (in module experiment_runner.main) (in module xai4tsc.data.base) (in module xai4tsc.data.data_loaders) (in module xai4tsc.data.datasets) (in module xai4tsc.evaluation.base) (in module xai4tsc.evaluation.evaluate) (in module xai4tsc.evaluation.timefrequency_auc) (in module xai4tsc.models.base) (in module xai4tsc.models.models) (in module xai4tsc.utils.animation) (in module xai4tsc.utils.perturbation) (in module xai4tsc.utils.plot) (in module xai4tsc.utils.utils) (in module xai4tsc.xai.explain) (in module xai4tsc.xai.feature_attribution) (in module xai4tsc.xai.freqrise) (in module xai4tsc.xai.wrappers)

LSTM (class in xai4tsc.models.models) lstm (xai4tsc.models.models.LSTM attribute)

M

main() (in module experiment_runner.main) MASTER_CONFIG (in module experiment_runner.main) max_freq (xai4tsc.data.datasets.FreqShapesDataset attribute) merge_dicts() (in module xai4tsc.utils.utils) metadata (xai4tsc.evaluation.timefrequency_auc.TimeFrequencyAUCEvaluator attribute) metric_name (xai4tsc.evaluation.base.EvaluatorBase attribute) (xai4tsc.evaluation.base.QuantusEvaluator attribute) METRICS (in module xai4tsc.evaluation.evaluate) model_path (xai4tsc.models.base.ModelBase attribute) ModelBase (class in xai4tsc.models.base) MODELS (in module xai4tsc.models.models) module experiment_runner experiment_runner.cache experiment_runner.config experiment_runner.download_datasets experiment_runner.evaluate experiment_runner.explain experiment_runner.log_setup experiment_runner.main xai4tsc xai4tsc.data xai4tsc.data.base xai4tsc.data.data_loaders xai4tsc.data.datasets xai4tsc.evaluation xai4tsc.evaluation.base xai4tsc.evaluation.evaluate xai4tsc.evaluation.frequency_evaluate xai4tsc.evaluation.timefrequency_auc xai4tsc.evaluation.timefrequency_perturbation xai4tsc.logging_config xai4tsc.models xai4tsc.models.base xai4tsc.models.models xai4tsc.utils xai4tsc.utils.animation xai4tsc.utils.defaults xai4tsc.utils.fourier_transforms xai4tsc.utils.perturbation xai4tsc.utils.plot xai4tsc.utils.utils xai4tsc.xai xai4tsc.xai.base xai4tsc.xai.explain xai4tsc.xai.explanation_domains xai4tsc.xai.feature_attribution xai4tsc.xai.freqrise xai4tsc.xai.random_baseline xai4tsc.xai.wrappers

mu (xai4tsc.xai.wrappers.SignExplainer attribute) MultiHotLabelEncoder (class in xai4tsc.data.base)

N

n (xai4tsc.utils.fourier_transforms.FourierTransform attribute) (xai4tsc.utils.fourier_transforms.RFFTransform attribute) n_fft (xai4tsc.utils.fourier_transforms.STFTransform attribute) n_global_distractors (xai4tsc.data.datasets.FreqShapesDataset attribute) n_local_distractors (xai4tsc.data.datasets.FreqShapesDataset attribute) n_perturb_samples (xai4tsc.xai.feature_attribution.TSHAPExplainer attribute) n_samples (xai4tsc.data.datasets.FreqShapesDataset attribute)

name (xai4tsc.data.base.DatasetBase attribute) (xai4tsc.data.datasets.LocalDataset attribute) (xai4tsc.data.datasets.SyntheticDataset attribute) (xai4tsc.data.datasets.UcrUeaDataset attribute) (xai4tsc.models.base.ModelBase attribute) norm (xai4tsc.models.models.XLSTM attribute) num_batches (xai4tsc.xai.freqrise.FreqRISEExplainer attribute) num_cells (xai4tsc.xai.freqrise.FreqRISEExplainer attribute)

O

OcclusionExplainer (class in xai4tsc.xai.feature_attribution)

P

packet_len (xai4tsc.data.datasets.FreqShapesDataset attribute) pad_series (xai4tsc.data.datasets.LocalDataset attribute) (xai4tsc.data.datasets.UcrUeaDataset attribute) parser (in module experiment_runner.main) patch_embed (xai4tsc.models.models.PatchTST attribute) patch_len (xai4tsc.models.models.PatchTST attribute) PatchTST (class in xai4tsc.models.models) path (xai4tsc.data.datasets.LocalDataset attribute) perturb_baseline (xai4tsc.evaluation.frequency_evaluate.PerturbationEvaluator attribute) (xai4tsc.xai.feature_attribution.TSHAPExplainer attribute) PerturbationEvaluator (class in xai4tsc.evaluation.frequency_evaluate)

PerturbationExplainer (class in xai4tsc.xai.base) plot_exp() (in module xai4tsc.xai.explain) plot_perturbation_curve() (in module xai4tsc.utils.plot) plot_relevance() (in module xai4tsc.utils.plot) plot_relevance_f() (in module xai4tsc.utils.plot) plot_relevance_tf() (in module xai4tsc.utils.plot) predict() (xai4tsc.models.base.ModelBase method) prng (xai4tsc.xai.feature_attribution.TSHAPExplainer attribute) (xai4tsc.xai.random_baseline.RandomFrequencyExplainer attribute) (xai4tsc.xai.random_baseline.RandomTimeFreqExplainer attribute) probability_of_drop (xai4tsc.xai.freqrise.FreqRISEExplainer attribute)

Q

QUANTUS_METRICS (in module xai4tsc.evaluation.evaluate)

QuantusEvaluator (class in xai4tsc.evaluation.base)

R

RandomFrequencyExplainer (class in xai4tsc.xai.random_baseline) RandomTimeFreqExplainer (class in xai4tsc.xai.random_baseline) real_attribution() (xai4tsc.evaluation.base.EvaluatorBase static method) register_explainer() (in module xai4tsc.xai.explain) register_external_components() (in module experiment_runner.config) register_metric() (in module xai4tsc.evaluation.evaluate) register_model() (in module xai4tsc.models.models) register_synthetic_dataset() (in module xai4tsc.data.datasets) remove_file_log() (in module xai4tsc.logging_config) required_domains (xai4tsc.evaluation.base.EvaluatorBase attribute) (xai4tsc.evaluation.frequency_evaluate.FrequencyEvaluator attribute) (xai4tsc.evaluation.frequency_evaluate.PerturbationEvaluator attribute) (xai4tsc.evaluation.timefrequency_auc.TimeFrequencyAUCEvaluator attribute) (xai4tsc.evaluation.timefrequency_perturbation.TimeFrequencyEvaluator attribute)

rescale_array() (in module xai4tsc.utils.utils) ResNet (class in xai4tsc.models.models) resolve_perturb_func() (in module xai4tsc.utils.perturbation) resolve_transform() (in module xai4tsc.utils.fourier_transforms) return_aggregate (xai4tsc.evaluation.timefrequency_auc.TimeFrequencyAUCEvaluator attribute) return_aoc_per_sample (xai4tsc.evaluation.frequency_evaluate.PerturbationEvaluator attribute) RFFTransform (class in xai4tsc.utils.fourier_transforms) roi (xai4tsc.xai.feature_attribution.TSHAPExplainer attribute)

S

save_model() (in module xai4tsc.models.models) (xai4tsc.models.base.ModelBase method) save_path (xai4tsc.models.base.ModelBase attribute) save_splits() (xai4tsc.data.base.DatasetBase method) seed (xai4tsc.data.datasets.SyntheticDataset attribute) (xai4tsc.xai.freqrise.FreqRISEExplainer attribute) sigma (xai4tsc.evaluation.timefrequency_perturbation.TimeFrequencyEvaluatorGaussian attribute) signal_length (xai4tsc.utils.fourier_transforms.STFTransform attribute) SignExplainer (class in xai4tsc.xai.wrappers)

split() (xai4tsc.data.base.DatasetBase method) (xai4tsc.data.datasets.UcrUeaDataset method) STFTransform (class in xai4tsc.utils.fourier_transforms) stride (xai4tsc.models.models.PatchTST attribute) (xai4tsc.xai.feature_attribution.TSHAPExplainer attribute) strides (xai4tsc.xai.feature_attribution.OcclusionExplainer attribute) SurrogateExplainer (class in xai4tsc.xai.base) SYNTHETIC_DATASETS (in module xai4tsc.data.datasets) SyntheticDataset (class in xai4tsc.data.datasets)

T

t_con_defaults (in module xai4tsc.utils.defaults) TimeFrequencyAUCEvaluator (class in xai4tsc.evaluation.timefrequency_auc) TimeFrequencyEvaluator (class in xai4tsc.evaluation.timefrequency_perturbation) TimeFrequencyEvaluatorGaussian (class in xai4tsc.evaluation.timefrequency_perturbation) TimeFrequencyExplainer (class in xai4tsc.xai.explanation_domains) TimeFrequencyPerturbationAnimation (class in xai4tsc.utils.animation) train_model() (xai4tsc.models.base.ModelBase method) transform (xai4tsc.evaluation.frequency_evaluate.PerturbationEvaluator attribute) (xai4tsc.evaluation.timefrequency_auc.TimeFrequencyAUCEvaluator attribute) (xai4tsc.xai.explanation_domains.FrequencyExplainer attribute) (xai4tsc.xai.explanation_domains.TimeFrequencyExplainer attribute) (xai4tsc.xai.freqrise.FreqRISEExplainer attribute) (xai4tsc.xai.random_baseline.RandomFrequencyExplainer attribute) (xai4tsc.xai.random_baseline.RandomTimeFreqExplainer attribute)

transform() (xai4tsc.data.base.MultiHotLabelEncoder method) TSHAPExplainer (class in xai4tsc.xai.feature_attribution)

U

UCR_BULK_URL (in module experiment_runner.download_datasets) UcrUeaDataset (class in xai4tsc.data.datasets)

UEA_BULK_URL (in module experiment_runner.download_datasets) use_predefined_splits (xai4tsc.data.datasets.UcrUeaDataset attribute)

W

win_length (xai4tsc.utils.fourier_transforms.STFTransform attribute) window (xai4tsc.utils.fourier_transforms.STFTransform attribute)

window_length (xai4tsc.xai.feature_attribution.TSHAPExplainer attribute) window_shape (xai4tsc.xai.feature_attribution.OcclusionExplainer attribute) WrapperExplainer (class in xai4tsc.xai.base)

X

xai4tsc module xai4tsc.data module xai4tsc.data.base module xai4tsc.data.data_loaders module xai4tsc.data.datasets module xai4tsc.evaluation module xai4tsc.evaluation.base module xai4tsc.evaluation.evaluate module xai4tsc.evaluation.frequency_evaluate module xai4tsc.evaluation.timefrequency_auc module xai4tsc.evaluation.timefrequency_perturbation module xai4tsc.logging_config module xai4tsc.models module xai4tsc.models.base module xai4tsc.models.models module

xai4tsc.utils module xai4tsc.utils.animation module xai4tsc.utils.defaults module xai4tsc.utils.fourier_transforms module xai4tsc.utils.perturbation module xai4tsc.utils.plot module xai4tsc.utils.utils module xai4tsc.xai module xai4tsc.xai.base module xai4tsc.xai.explain module xai4tsc.xai.explanation_domains module xai4tsc.xai.feature_attribution module xai4tsc.xai.freqrise module xai4tsc.xai.random_baseline module xai4tsc.xai.wrappers module XLSTM (class in xai4tsc.models.models)