EnergyFaultDetector Logo

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
    • energy_fault_detector
      • Config
      • FaultDetector
      • anomaly_scores
      • autoencoders
      • config
      • core
      • data_preprocessing
      • data_splitting
      • evaluation
        • evaluation.care2compare
        • evaluation.care_score
        • evaluation.predist_dataset
      • quick_fault_detection
      • root_cause_analysis
      • threshold_selectors
      • utils
      • registration
EnergyFaultDetector
  • energy_fault_detector
  • energy_fault_detector
  • evaluation

evaluation

Benchmark metrics and dataset loaders for evaluating fault-detection models.

  • evaluation.care2compare
    • Care2CompareDataset
      • Care2CompareDataset.format_event_dataset()
      • Care2CompareDataset.get_event_info()
      • Care2CompareDataset.iter_datasets()
      • Care2CompareDataset.iter_formatted_datasets()
      • Care2CompareDataset.iter_train_datasets_per_asset()
      • Care2CompareDataset.load_and_format_event_dataset()
      • Care2CompareDataset.load_event_dataset()
      • Care2CompareDataset.update_c2c_config()
  • evaluation.care_score
    • CAREScore
      • CAREScore.calculate_avg_accuracy()
      • CAREScore.calculate_avg_coverage()
      • CAREScore.calculate_avg_earliness()
      • CAREScore.calculate_reliability()
      • CAREScore.create_ground_truth()
      • CAREScore.evaluate_event()
      • CAREScore.evaluated_events
      • CAREScore.get_final_score()
      • CAREScore.load_evaluated_events()
      • CAREScore.save_evaluated_events()
  • evaluation.predist_dataset
    • PreDistDataset
      • PreDistDataset.events
      • PreDistDataset.FAULT_HOURS_AFTER
      • PreDistDataset.FAULT_HOURS_BEFORE
      • PreDistDataset.create_normal_flag()
      • PreDistDataset.get_event_data()
      • PreDistDataset.load_substation_data()
Previous Next

© Copyright 2025, Fraunhofer IEE.

Built with Sphinx using a theme provided by Read the Docs.