EnergyFaultDetector
Getting started
Usage examples
Quick fault detection (CLI)
Configuration
Models and methods
ARCANA: Root cause analysis
CARE2Compare guide
CARE2Compare FAQ
Model overview
Sequence models
Sequence-to-one models
Sequence-to-sequence models
Anomaly scores
Advanced usage
Advanced usage and customization
Logging Configuration
API reference
The EnergyFaultDetector package
EnergyFaultDetector
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
_
__call__() (Autoencoder method)
A
actual_false_discovery_rate_ (FDRSelector attribute)
AdaptiveThresholdSelector (class in energy_fault_detector.threshold_selectors)
angles (AngleTransformer attribute)
AngleTransformer (class in energy_fault_detector.data_preprocessing.angle_transformer)
animate_bias() (in module energy_fault_detector.utils.visualisation)
animate_corrected_input() (in module energy_fault_detector.utils.visualisation)
anomaly_score (FaultDetectionResult attribute)
(FaultDetector attribute)
AnomalyScore (class in energy_fault_detector.core)
apply_weights_to_squared_residuals() (WeightedRMSEScore method)
Arcana (class in energy_fault_detector.root_cause_analysis.arcana)
arcana_losses (FaultDetectionResult attribute)
arcana_params (Config property)
Autoencoder (class in energy_fault_detector.core.autoencoder)
autoencoder (FaultDetector attribute)
B
bias_data (FaultDetectionResult attribute)
BidirectionalLSTMSeq2OneAutoencoder (class in energy_fault_detector.autoencoders)
BlockDataSplitter (class in energy_fault_detector.data_splitting.data_splitter)
build_seq2one_dataset() (SequenceDatasetBuilder method)
build_sliding_dataset() (SequenceDatasetBuilder method)
C
calculate_arcana_importance_time_series() (in module energy_fault_detector.root_cause_analysis.arcana_utils)
calculate_avg_accuracy() (CAREScore method)
calculate_avg_coverage() (CAREScore method)
calculate_avg_earliness() (CAREScore method)
calculate_criticality() (in module energy_fault_detector.utils.analysis)
calculate_mean_arcana_importances() (in module energy_fault_detector.root_cause_analysis.arcana_utils)
calculate_reliability() (CAREScore method)
callbacks (Autoencoder attribute)
Care2CompareDataset (class in energy_fault_detector.evaluation.care2compare)
CAREScore (class in energy_fault_detector.evaluation.care_score)
categorical_columns (CategoricalEncoder attribute)
(ForwardFillImputer attribute)
(Imputer attribute)
categorical_features (CategoricalEncoder attribute)
(ForwardFillImputer attribute)
(Imputer attribute)
(Scaler attribute)
categorical_imputer (Imputer attribute)
CategoricalEncoder (class in energy_fault_detector.data_preprocessing.categorical_encoder)
CNNAutoencoder (class in energy_fault_detector.autoencoders)
CNNSeq2OneAutoencoder (class in energy_fault_detector.autoencoders)
columns_dropped_ (ColumnSelector attribute)
(LowUniqueValueFilter attribute)
(Scaler attribute)
ColumnSelector (class in energy_fault_detector.data_preprocessing.column_selector)
compile_model() (Autoencoder method)
ConditionalAE (class in energy_fault_detector.autoencoders)
Config (class in energy_fault_detector)
CounterDiffTransformer (class in energy_fault_detector.data_preprocessing.counter_diff_transformer)
create_events() (in module energy_fault_detector.utils.analysis)
create_ground_truth() (CAREScore static method)
create_model() (Autoencoder method)
(BidirectionalLSTMSeq2OneAutoencoder method)
(CNNAutoencoder method)
(CNNSeq2OneAutoencoder method)
(ConditionalAE method)
(LSTMSeq2OneAutoencoder method)
(LSTMSeqAutoencoder method)
(MultilayerAutoencoder method)
create_normal_flag() (PreDistDataset method)
criticality() (FaultDetectionResult method)
D
data_clipping (Config property)
data_clipping_params (Config property)
data_gaps (DataGapHandler attribute)
data_preprocessor (FaultDetector attribute)
data_preprocessor_steps (Config property)
data_split_params (Config property)
DataClipper (class in energy_fault_detector.data_preprocessing.data_clipper)
DataGapHandler (class in energy_fault_detector.data_splitting.data_gap_handler)
DataPreprocessor (class in energy_fault_detector.data_preprocessing.data_preprocessor)
DataTransformer (class in energy_fault_detector.core)
download_backblaze_data() (in module energy_fault_detector.utils.data_downloads)
download_zenodo_data() (in module energy_fault_detector.utils.data_downloads)
draw_samples() (Arcana method)
dtype (Config property)
DuplicateValuesToNan (class in energy_fault_detector.data_preprocessing.duplicate_value_to_nan)
E
encode() (Autoencoder method)
(SequenceAutoencoder method)
encoder (Autoencoder attribute)
(ConditionalAE attribute)
(MultilayerAutoencoder attribute)
energy_fault_detector
module
energy_fault_detector.anomaly_scores
module
energy_fault_detector.anomaly_scores.weighted_rmse_score
module
energy_fault_detector.autoencoders
module
energy_fault_detector.autoencoders.seq2one_autoencoder
module
energy_fault_detector.autoencoders.seq2seq_autoencoder
module
energy_fault_detector.autoencoders.sequence_autoencoder
module
energy_fault_detector.core
module
energy_fault_detector.core.autoencoder
module
energy_fault_detector.data_preprocessing
module
energy_fault_detector.data_preprocessing.angle_transformer
module
energy_fault_detector.data_preprocessing.categorical_encoder
module
energy_fault_detector.data_preprocessing.column_selector
module
energy_fault_detector.data_preprocessing.counter_diff_transformer
module
energy_fault_detector.data_preprocessing.data_clipper
module
energy_fault_detector.data_preprocessing.data_preprocessor
module
energy_fault_detector.data_preprocessing.duplicate_value_to_nan
module
energy_fault_detector.data_preprocessing.ffill_imputer
module
energy_fault_detector.data_preprocessing.imputer
module
energy_fault_detector.data_preprocessing.low_unique_value_filter
module
energy_fault_detector.data_preprocessing.scaler
module
energy_fault_detector.data_preprocessing.timestamp_transformer
module
energy_fault_detector.data_splitting
module
energy_fault_detector.data_splitting.data_gap_handler
module
energy_fault_detector.data_splitting.data_splitter
module
energy_fault_detector.data_splitting.sequence_dataset
module
energy_fault_detector.evaluation
module
energy_fault_detector.evaluation.care2compare
module
energy_fault_detector.evaluation.care_score
module
energy_fault_detector.evaluation.predist_dataset
module
energy_fault_detector.quick_fault_detection
module
energy_fault_detector.registration
module
energy_fault_detector.root_cause_analysis
module
energy_fault_detector.root_cause_analysis.arcana
module
energy_fault_detector.root_cause_analysis.arcana_utils
module
energy_fault_detector.threshold_selectors
module
energy_fault_detector.utils
module
energy_fault_detector.utils.analysis
module
energy_fault_detector.utils.data_downloads
module
energy_fault_detector.utils.visualisation
module
epochs_completed (Autoencoder property)
evaluate_event() (CAREScore method)
evaluated_events (CAREScore property)
events (PreDistDataset attribute)
F
FAULT_HOURS_AFTER (PreDistDataset attribute)
FAULT_HOURS_BEFORE (PreDistDataset attribute)
FaultDetectionResult (class in energy_fault_detector.core)
FaultDetector (class in energy_fault_detector)
FbetaSelector (class in energy_fault_detector.threshold_selectors)
FDRSelector (class in energy_fault_detector.threshold_selectors)
feature_names_in_ (CategoricalEncoder attribute)
(ColumnSelector attribute)
(DuplicateValuesToNan attribute)
(ForwardFillImputer attribute)
(Imputer attribute)
(LowUniqueValueFilter attribute)
(Scaler attribute)
feature_names_out_ (CategoricalEncoder attribute)
(ColumnSelector attribute)
(DuplicateValuesToNan attribute)
(ForwardFillImputer attribute)
(Imputer attribute)
(LowUniqueValueFilter attribute)
(Scaler attribute)
feature_weights (WeightedRMSEScore attribute)
ffill_limit_ (ForwardFillImputer attribute)
find_arcana_bias() (Arcana method)
fit() (AdaptiveThresholdSelector method)
(AngleTransformer method)
(AnomalyScore method)
(Autoencoder method)
(CategoricalEncoder method)
(ColumnSelector method)
(CounterDiffTransformer method)
(DataClipper method)
(DataPreprocessor method)
(DataTransformer method)
(DuplicateValuesToNan method)
(FaultDetector method)
(FbetaSelector method)
(FDRSelector method)
(ForwardFillImputer method)
(Imputer method)
(LowUniqueValueFilter method)
(MahalanobisScore method)
(QuantileThresholdSelector method)
(RMSEScore method)
(Scaler method)
(SequenceAutoencoder method)
(ThresholdSelector method)
(TimestampTransformer method)
(WeightedRMSEScore method)
fit_threshold_on_val (Config property)
fit_transform() (DataPreprocessor method)
format_event_dataset() (Care2CompareDataset static method)
ForwardFillImputer (class in energy_fault_detector.data_preprocessing.ffill_imputer)
freq (DataGapHandler attribute)
G
get() (Registry method)
get_alternative_class_names() (Registry method)
get_event_data() (PreDistDataset method)
get_event_info() (Care2CompareDataset method)
get_feature_names_out() (AngleTransformer method)
(CategoricalEncoder method)
(ColumnSelector method)
(CounterDiffTransformer method)
(DataClipper method)
(DataTransformer method)
(DuplicateValuesToNan method)
(ForwardFillImputer method)
(Imputer method)
(LowUniqueValueFilter method)
(Scaler method)
(TimestampTransformer method)
get_final_score() (CAREScore method)
get_next_gap_after() (DataGapHandler method)
get_reconstruction_error() (Autoencoder method)
(SequenceAutoencoder method)
H
has_data_gaps() (DataGapHandler method)
history (Autoencoder attribute)
(CNNAutoencoder attribute)
(ConditionalAE attribute)
(MultilayerAutoencoder attribute)
I
Imputer (class in energy_fault_detector.data_preprocessing.imputer)
initialize_x_bias() (Arcana method)
input_index_ (Imputer attribute)
inverse_transform() (AngleTransformer method)
(CategoricalEncoder method)
(ColumnSelector method)
(CounterDiffTransformer method)
(DataClipper method)
(DataPreprocessor method)
(DataTransformer method)
(DuplicateValuesToNan method)
(ForwardFillImputer method)
(Imputer method)
(LowUniqueValueFilter method)
(Scaler method)
(TimestampTransformer method)
is_conditional (Autoencoder attribute)
is_in_gap() (DataGapHandler method)
iter_datasets() (Care2CompareDataset method)
iter_formatted_datasets() (Care2CompareDataset method)
iter_train_datasets_per_asset() (Care2CompareDataset method)
L
load() (Autoencoder method)
(FaultDetectionResult class method)
load_and_format_event_dataset() (Care2CompareDataset method)
load_evaluated_events() (CAREScore method)
load_event_dataset() (Care2CompareDataset method)
load_substation_data() (PreDistDataset method)
LowUniqueValueFilter (class in energy_fault_detector.data_preprocessing.low_unique_value_filter)
LSTMSeq2OneAutoencoder (class in energy_fault_detector.autoencoders)
LSTMSeqAutoencoder (class in energy_fault_detector.autoencoders)
M
MahalanobisScore (class in energy_fault_detector.anomaly_scores)
mark_normal_outliers() (FbetaSelector method)
max_criticality (Config property)
model (Autoencoder attribute)
(CNNAutoencoder attribute)
(ConditionalAE attribute)
(MultilayerAutoencoder attribute)
model_date (ModelMetadata attribute)
model_path (ModelMetadata attribute)
ModelMetadata (class in energy_fault_detector.core)
module
energy_fault_detector
energy_fault_detector.anomaly_scores
energy_fault_detector.anomaly_scores.weighted_rmse_score
energy_fault_detector.autoencoders
energy_fault_detector.autoencoders.seq2one_autoencoder
energy_fault_detector.autoencoders.seq2seq_autoencoder
energy_fault_detector.autoencoders.sequence_autoencoder
energy_fault_detector.core
energy_fault_detector.core.autoencoder
energy_fault_detector.data_preprocessing
energy_fault_detector.data_preprocessing.angle_transformer
energy_fault_detector.data_preprocessing.categorical_encoder
energy_fault_detector.data_preprocessing.column_selector
energy_fault_detector.data_preprocessing.counter_diff_transformer
energy_fault_detector.data_preprocessing.data_clipper
energy_fault_detector.data_preprocessing.data_preprocessor
energy_fault_detector.data_preprocessing.duplicate_value_to_nan
energy_fault_detector.data_preprocessing.ffill_imputer
energy_fault_detector.data_preprocessing.imputer
energy_fault_detector.data_preprocessing.low_unique_value_filter
energy_fault_detector.data_preprocessing.scaler
energy_fault_detector.data_preprocessing.timestamp_transformer
energy_fault_detector.data_splitting
energy_fault_detector.data_splitting.data_gap_handler
energy_fault_detector.data_splitting.data_splitter
energy_fault_detector.data_splitting.sequence_dataset
energy_fault_detector.evaluation
energy_fault_detector.evaluation.care2compare
energy_fault_detector.evaluation.care_score
energy_fault_detector.evaluation.predist_dataset
energy_fault_detector.quick_fault_detection
energy_fault_detector.registration
energy_fault_detector.root_cause_analysis
energy_fault_detector.root_cause_analysis.arcana
energy_fault_detector.root_cause_analysis.arcana_utils
energy_fault_detector.threshold_selectors
energy_fault_detector.utils
energy_fault_detector.utils.analysis
energy_fault_detector.utils.data_downloads
energy_fault_detector.utils.visualisation
MultilayerAutoencoder (class in energy_fault_detector.autoencoders)
N
n_features_in_ (CategoricalEncoder attribute)
(ColumnSelector attribute)
(Imputer attribute)
(LowUniqueValueFilter attribute)
NAME_ALIASES (DataPreprocessor attribute)
non_declared_categorical_features (CategoricalEncoder attribute)
(ForwardFillImputer attribute)
(Imputer attribute)
numerical_columns (CategoricalEncoder attribute)
(ForwardFillImputer attribute)
(Imputer attribute)
numerical_imputer (Imputer attribute)
O
one_hot_encoder (CategoricalEncoder attribute)
opt (Arcana attribute)
P
params (Imputer attribute)
(Scaler attribute)
plot_arcana_importance_series() (in module energy_fault_detector.utils.visualisation)
plot_arcana_losses() (in module energy_fault_detector.utils.visualisation)
plot_arcana_mean_importances() (in module energy_fault_detector.utils.visualisation)
plot_learning_curve() (in module energy_fault_detector.utils.visualisation)
plot_reconstruction() (in module energy_fault_detector.utils.visualisation)
plot_reconstruction_with_model() (in module energy_fault_detector.utils.visualisation)
plot_score_with_threshold() (in module energy_fault_detector.utils.visualisation)
predict() (AdaptiveThresholdSelector method)
(Autoencoder method)
(FaultDetector method)
(SequenceAutoencoder method)
(ThresholdSelector method)
predict_anomalies() (FaultDetector method)
predict_anomaly_score() (FaultDetector method)
predicted_anomalies (FaultDetectionResult attribute)
PreDistDataset (class in energy_fault_detector.evaluation.predist_dataset)
preprocess_train_data() (FaultDetector method)
print_available_classes() (Registry method)
protect_conditional_features (Config property)
Q
QuantileThresholdSelector (class in energy_fault_detector.threshold_selectors)
quick_fault_detector() (in module energy_fault_detector.quick_fault_detection)
R
recon_error (FaultDetectionResult attribute)
reconstruction (FaultDetectionResult attribute)
register() (in module energy_fault_detector.registration)
(Registry method)
Registry (class in energy_fault_detector.registration)
RMSEScore (class in energy_fault_detector.anomaly_scores)
root_cause_analysis (Config property)
run_root_cause_analysis() (FaultDetector method)
S
save() (Autoencoder method)
(FaultDetectionResult method)
save_evaluated_events() (CAREScore method)
save_timestamps (FaultDetector attribute)
scale_categorical_features (Scaler attribute)
scale_with_std() (WeightedRMSEScore method)
Scaler (class in energy_fault_detector.data_preprocessing.scaler)
scaler (Scaler attribute)
SCALER_REGISTRY (Scaler attribute)
scaler_type (Scaler attribute)
Seq2OneAutoencoder (class in energy_fault_detector.autoencoders.seq2one_autoencoder)
Seq2SeqAutoencoder (class in energy_fault_detector.autoencoders.seq2seq_autoencoder)
SequenceAutoencoder (class in energy_fault_detector.autoencoders.sequence_autoencoder)
SequenceDatasetBuilder (class in energy_fault_detector.data_splitting.sequence_dataset)
shift_array() (in module energy_fault_detector.data_splitting.data_gap_handler)
split() (BlockDataSplitter method)
split_inputs() (in module energy_fault_detector.core.autoencoder)
standardize() (MahalanobisScore method)
(RMSEScore method)
STEP_REGISTRY (DataPreprocessor attribute)
strategy (Imputer attribute)
summary() (Autoencoder method)
T
threshold (FbetaSelector attribute)
(FDRSelector attribute)
(QuantileThresholdSelector attribute)
(ThresholdSelector attribute)
threshold_selector (FaultDetector attribute)
ThresholdSelector (class in energy_fault_detector.core)
TimestampTransformer (class in energy_fault_detector.data_preprocessing.timestamp_transformer)
tracked_bias (FaultDetectionResult attribute)
train_recon_error (ModelMetadata attribute)
train_selection (BlockDataSplitter attribute)
transform() (AngleTransformer method)
(AnomalyScore method)
(CategoricalEncoder method)
(ColumnSelector method)
(CounterDiffTransformer method)
(DataClipper method)
(DataPreprocessor method)
(DataTransformer method)
(DuplicateValuesToNan method)
(ForwardFillImputer method)
(Imputer method)
(LowUniqueValueFilter method)
(MahalanobisScore method)
(RMSEScore method)
(Scaler method)
(TimestampTransformer method)
(WeightedRMSEScore method)
trust_bad_angles (AngleTransformer attribute)
tune() (Autoencoder method)
(FaultDetector method)
(SequenceAutoencoder method)
tune_decoder() (Autoencoder method)
(SequenceAutoencoder method)
U
update_c2c_config() (Care2CompareDataset method)
update_x_bias() (Arcana method)
V
val_recon_error (ModelMetadata attribute)
val_selection (BlockDataSplitter attribute)
W
WeightedRMSEScore (class in energy_fault_detector.anomaly_scores.weighted_rmse_score)