energy_fault_detector
Contents
Usage examples
Configuration
Logging Configuration
The EnergyFaultDetector package
energy_fault_detector
Index
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)
__sklearn_is_fitted__() (ThresholdSelector method)
A
actual_false_discovery_rate_ (FDRSelector attribute)
AdaptiveThresholdSelector (class in energy_fault_detector.threshold_selectors.adaptive_threshold)
analyze_event() (in module energy_fault_detector.quick_fault_detection.quick_fault_detector)
angle_features (Options attribute)
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 (FaultDetectionModel attribute)
(FaultDetectionResult attribute)
(FaultDetector attribute)
(ModelFactory property)
AnomalyScore (class in energy_fault_detector.core.anomaly_score)
apply_boolean_mapping() (in module energy_fault_detector.quick_fault_detection.data_loading)
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 (FaultDetectionModel attribute)
(FaultDetector attribute)
(ModelFactory property)
automatic_hyper_opt() (in module energy_fault_detector.quick_fault_detection.optimization)
automatic_optimization (Options attribute)
B
BaseConfig (class in energy_fault_detector.config.base_config)
bias_data (FaultDetectionResult attribute)
BlockDataSplitter (class in energy_fault_detector.data_splitting.data_splitter)
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)
columns_dropped_ (ColumnSelector attribute)
(LowUniqueValueFilter attribute)
ColumnSelector (class in energy_fault_detector.data_preprocessing.column_selector)
compile_model() (Autoencoder method)
ConditionalAE (class in energy_fault_detector.autoencoders.conditional_autoencoder)
Config (class in energy_fault_detector.config.config)
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)
(ConditionalAE method)
(MultilayerAutoencoder method)
(RegressionNN method)
create_normal_flag() (PreDistDataset method)
criticality() (FaultDetectionResult method)
csv_test_data_path (Options attribute)
D
data_clipping (Config property)
data_clipping_params (Config property)
data_preprocessor (FaultDetectionModel attribute)
(FaultDetector attribute)
(ModelFactory property)
data_split_params (Config property)
DataClipper (class in energy_fault_detector.data_preprocessing.data_clipper)
DataPreprocessor (class in energy_fault_detector.data_preprocessing.data_preprocessor)
DataTransformer (class in energy_fault_detector.core.data_transformer)
detect_encoding() (in module energy_fault_detector.quick_fault_detection.data_loading)
detect_separator() (in module energy_fault_detector.quick_fault_detection.data_loading)
download_file() (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
enable_debug_plots (Options attribute)
encode() (Autoencoder method)
encoder (Autoencoder attribute)
(ConditionalAE attribute)
(MultilayerAutoencoder attribute)
energy_fault_detector
module
energy_fault_detector.anomaly_scores
module
energy_fault_detector.anomaly_scores.mahalanobis_score
module
energy_fault_detector.anomaly_scores.rmse_score
module
energy_fault_detector.autoencoders
module
energy_fault_detector.autoencoders.conditional_autoencoder
module
energy_fault_detector.autoencoders.multilayer_autoencoder
module
energy_fault_detector.config
module
energy_fault_detector.config.base_config
module
energy_fault_detector.config.config
module
energy_fault_detector.config.quickstart_config
module
energy_fault_detector.core
module
energy_fault_detector.core.anomaly_score
module
energy_fault_detector.core.autoencoder
module
energy_fault_detector.core.data_transformer
module
energy_fault_detector.core.fault_detection_model
module
energy_fault_detector.core.fault_detection_result
module
energy_fault_detector.core.model_factory
module
energy_fault_detector.core.save_load_mixin
module
energy_fault_detector.core.threshold_selector
module
energy_fault_detector.data_preprocessing
module
energy_fault_detector.data_preprocessing.angle_transformer
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.low_unique_value_filter
module
energy_fault_detector.data_splitting
module
energy_fault_detector.data_splitting.data_splitter
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.fault_detector
module
energy_fault_detector.main
module
energy_fault_detector.quick_fault_detection
module
energy_fault_detector.quick_fault_detection.configuration
module
energy_fault_detector.quick_fault_detection.data_loading
module
energy_fault_detector.quick_fault_detection.optimization
module
energy_fault_detector.quick_fault_detection.output
module
energy_fault_detector.quick_fault_detection.quick_fault_detector
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.threshold_selectors.adaptive_threshold
module
energy_fault_detector.threshold_selectors.fbeta_threshold
module
energy_fault_detector.threshold_selectors.fdr_threshold
module
energy_fault_detector.threshold_selectors.quantile_threshold
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
evaluate_event() (CAREScore method)
evaluated_events (CAREScore property)
events (PreDistDataset attribute)
F
FAULT_HOURS_AFTER (PreDistDataset attribute)
FAULT_HOURS_BEFORE (PreDistDataset attribute)
FaultDetectionModel (class in energy_fault_detector.core.fault_detection_model)
FaultDetectionResult (class in energy_fault_detector.core.fault_detection_result)
FaultDetector (class in energy_fault_detector.fault_detector)
FbetaSelector (class in energy_fault_detector.threshold_selectors.fbeta_threshold)
FDRSelector (class in energy_fault_detector.threshold_selectors.fdr_threshold)
feature_names_in_ (ColumnSelector attribute)
(DuplicateValuesToNan attribute)
(LowUniqueValueFilter attribute)
feature_names_out_ (ColumnSelector attribute)
(DuplicateValuesToNan attribute)
(LowUniqueValueFilter attribute)
features_to_exclude (Options attribute)
fetch_record() (in module energy_fault_detector.utils.data_downloads)
find_arcana_bias() (Arcana method)
fit() (AdaptiveThresholdSelector method)
(AngleTransformer method)
(AnomalyScore method)
(Autoencoder method)
(ColumnSelector method)
(CounterDiffTransformer method)
(DataClipper method)
(DataTransformer method)
(DuplicateValuesToNan method)
(FaultDetectionModel method)
(FaultDetector method)
(FbetaSelector method)
(FDRSelector method)
(LowUniqueValueFilter method)
(MahalanobisScore method)
(QuantileThresholdSelector method)
(RegressionNN method)
(RMSEScore method)
(ThresholdSelector method)
fit_threshold_on_val (Config property)
fit_transform() (DataPreprocessor method)
format_event_dataset() (Care2CompareDataset static method)
G
generate_output_plots() (in module energy_fault_detector.quick_fault_detection.output)
generate_quickstart_config() (in module energy_fault_detector.config.quickstart_config)
get() (Registry method)
get_alternative_class_names() (Registry method)
get_boolean_feature() (in module energy_fault_detector.quick_fault_detection.data_loading)
get_event_data() (PreDistDataset method)
get_event_info() (Care2CompareDataset method)
get_feature_names_out() (AngleTransformer method)
(ColumnSelector method)
(CounterDiffTransformer method)
(DataClipper method)
(DataTransformer method)
(DuplicateValuesToNan method)
(LowUniqueValueFilter method)
get_final_score() (CAREScore method)
get_reconstruction_error() (Autoencoder method)
get_sensor_data() (in module energy_fault_detector.quick_fault_detection.data_loading)
H
history (Autoencoder attribute)
(ConditionalAE attribute)
(MultilayerAutoencoder attribute)
I
initialize_x_bias() (Arcana method)
InvalidConfigFile
inverse_transform() (AngleTransformer method)
(ColumnSelector method)
(CounterDiffTransformer method)
(DataClipper method)
(DataPreprocessor method)
(DataTransformer method)
(DuplicateValuesToNan method)
(LowUniqueValueFilter method)
is_conditional (Autoencoder attribute)
iter_datasets() (Care2CompareDataset method)
iter_formatted_datasets() (Care2CompareDataset method)
iter_train_datasets_per_asset() (Care2CompareDataset method)
L
list_files() (in module energy_fault_detector.utils.data_downloads)
load() (Autoencoder method)
(FaultDetectionResult class method)
(SaveLoadMixin method)
load_and_format_event_dataset() (Care2CompareDataset method)
load_data() (in module energy_fault_detector.quick_fault_detection.data_loading)
load_evaluated_events() (CAREScore method)
load_event_dataset() (Care2CompareDataset method)
load_models() (FaultDetectionModel method)
load_options_from_yaml() (in module energy_fault_detector.main)
load_substation_data() (PreDistDataset method)
load_train_test_data() (in module energy_fault_detector.quick_fault_detection.data_loading)
LowUniqueValueFilter (class in energy_fault_detector.data_preprocessing.low_unique_value_filter)
M
MahalanobisScore (class in energy_fault_detector.anomaly_scores.mahalanobis_score)
main() (in module energy_fault_detector.main)
mark_normal_outliers() (FbetaSelector method)
max_criticality (Config property)
min_anomaly_length (Options attribute)
model (Autoencoder attribute)
(ConditionalAE attribute)
(MultilayerAutoencoder attribute)
model_date (ModelMetadata attribute)
model_path (ModelMetadata attribute)
ModelFactory (class in energy_fault_detector.core.model_factory)
ModelMetadata (class in energy_fault_detector.core.fault_detection_result)
module
energy_fault_detector
energy_fault_detector.anomaly_scores
energy_fault_detector.anomaly_scores.mahalanobis_score
energy_fault_detector.anomaly_scores.rmse_score
energy_fault_detector.autoencoders
energy_fault_detector.autoencoders.conditional_autoencoder
energy_fault_detector.autoencoders.multilayer_autoencoder
energy_fault_detector.config
energy_fault_detector.config.base_config
energy_fault_detector.config.config
energy_fault_detector.config.quickstart_config
energy_fault_detector.core
energy_fault_detector.core.anomaly_score
energy_fault_detector.core.autoencoder
energy_fault_detector.core.data_transformer
energy_fault_detector.core.fault_detection_model
energy_fault_detector.core.fault_detection_result
energy_fault_detector.core.model_factory
energy_fault_detector.core.save_load_mixin
energy_fault_detector.core.threshold_selector
energy_fault_detector.data_preprocessing
energy_fault_detector.data_preprocessing.angle_transformer
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.low_unique_value_filter
energy_fault_detector.data_splitting
energy_fault_detector.data_splitting.data_splitter
energy_fault_detector.evaluation
energy_fault_detector.evaluation.care2compare
energy_fault_detector.evaluation.care_score
energy_fault_detector.evaluation.predist_dataset
energy_fault_detector.fault_detector
energy_fault_detector.main
energy_fault_detector.quick_fault_detection
energy_fault_detector.quick_fault_detection.configuration
energy_fault_detector.quick_fault_detection.data_loading
energy_fault_detector.quick_fault_detection.optimization
energy_fault_detector.quick_fault_detection.output
energy_fault_detector.quick_fault_detection.quick_fault_detector
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.threshold_selectors.adaptive_threshold
energy_fault_detector.threshold_selectors.fbeta_threshold
energy_fault_detector.threshold_selectors.fdr_threshold
energy_fault_detector.threshold_selectors.quantile_threshold
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.multilayer_autoencoder)
N
n_features_in_ (ColumnSelector attribute)
(LowUniqueValueFilter attribute)
NAME_ALIASES (DataPreprocessor attribute)
NoTrainingData
O
opt (Arcana attribute)
Options (class in energy_fault_detector.main)
P
parse_record_id() (in module energy_fault_detector.utils.data_downloads)
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)
(FaultDetectionModel method)
(FaultDetector method)
(RegressionNN 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)
prepare_output_dir() (in module energy_fault_detector.utils.data_downloads)
preprocess_train_data() (FaultDetector method)
print_available_classes() (Registry method)
Q
QuantileThresholdSelector (class in energy_fault_detector.threshold_selectors.quantile_threshold)
quick_fault_detector() (in module energy_fault_detector.quick_fault_detection.quick_fault_detector)
R
read_config() (BaseConfig method)
read_csv_file() (in module energy_fault_detector.quick_fault_detection.data_loading)
recon_error (FaultDetectionResult attribute)
reconstruction (FaultDetectionResult attribute)
recursive_safe_extract() (in module energy_fault_detector.utils.data_downloads)
register() (in module energy_fault_detector.registration)
(Registry method)
Registry (class in energy_fault_detector.registration)
RegressionNN (class in energy_fault_detector.threshold_selectors.adaptive_threshold)
RMSEScore (class in energy_fault_detector.anomaly_scores.rmse_score)
root_cause_analysis (Config property)
run_root_cause_analysis() (FaultDetector method)
S
safe_extract_zip() (in module energy_fault_detector.utils.data_downloads)
save() (Autoencoder method)
(FaultDetectionResult method)
(SaveLoadMixin method)
save_evaluated_events() (CAREScore method)
save_models() (FaultDetectionModel method)
save_timestamps (FaultDetectionModel attribute)
(FaultDetector attribute)
SaveLoadMixin (class in energy_fault_detector.core.save_load_mixin)
scale (RMSEScore attribute)
select_config() (in module energy_fault_detector.quick_fault_detection.configuration)
split() (BlockDataSplitter method)
split_inputs() (in module energy_fault_detector.core.autoencoder)
status_data_column_name (Options attribute)
status_label_confidence_percentage (Options attribute)
status_mapping (Options attribute)
STEP_REGISTRY (DataPreprocessor attribute)
T
threshold (FbetaSelector attribute)
(FDRSelector attribute)
(QuantileThresholdSelector attribute)
(ThresholdSelector attribute)
threshold_selector (FaultDetectionModel attribute)
(FaultDetector attribute)
(ModelFactory property)
ThresholdSelector (class in energy_fault_detector.core.threshold_selector)
time_column_name (Options attribute)
tracked_bias (FaultDetectionResult attribute)
train() (FaultDetectionModel method)
train_recon_error (ModelMetadata attribute)
train_selection (BlockDataSplitter attribute)
train_test_column_name (Options attribute)
train_test_mapping (Options attribute)
train_val_split() (FaultDetectionModel method)
transform() (AngleTransformer method)
(AnomalyScore method)
(ColumnSelector method)
(CounterDiffTransformer method)
(DataClipper method)
(DataPreprocessor method)
(DataTransformer method)
(DuplicateValuesToNan method)
(LowUniqueValueFilter method)
(MahalanobisScore method)
(RMSEScore method)
trust_bad_angles (AngleTransformer attribute)
tune() (Autoencoder method)
(FaultDetector method)
tune_decoder() (Autoencoder method)
U
update_autoencoder_config() (in module energy_fault_detector.quick_fault_detection.configuration)
update_c2c_config() (Care2CompareDataset method)
update_config() (BaseConfig method)
update_preprocessor_config() (in module energy_fault_detector.quick_fault_detection.configuration)
update_threshold_config() (in module energy_fault_detector.quick_fault_detection.configuration)
update_x_bias() (Arcana method)
V
val_recon_error (ModelMetadata attribute)
val_selection (BlockDataSplitter attribute)
validate_mapping() (in module energy_fault_detector.quick_fault_detection.data_loading)
verbose (Config property)
W
write_config() (BaseConfig method)