epyt_control

• epyt_control.envs
  • epyt_control.envs.actions
    • epyt_control.envs.actions.actions
      • Action
        • Action.apply()
        • Action.to_gym_action_space()
    • epyt_control.envs.actions.actuator_state_actions
      • ActuatorStateAction
        • ActuatorStateAction.action_space
        • ActuatorStateAction.to_gym_action_space()
      • PumpStateAction
        • PumpStateAction.apply()
        • PumpStateAction.pump_id
      • ValveStateAction
        • ValveStateAction.apply()
        • ValveStateAction.valve_id
    • epyt_control.envs.actions.pump_speed_actions
      • PumpSpeedAction
        • PumpSpeedAction.apply()
        • PumpSpeedAction.pump_id
        • PumpSpeedAction.speed_lower_bound
        • PumpSpeedAction.speed_upper_bound
        • PumpSpeedAction.to_gym_action_space()
    • epyt_control.envs.actions.quality_actions
      • ChemicalInjectionAction
        • ChemicalInjectionAction.apply()
        • ChemicalInjectionAction.node_id
        • ChemicalInjectionAction.pattern_id
        • ChemicalInjectionAction.source_type_id
        • ChemicalInjectionAction.to_gym_action_space()
        • ChemicalInjectionAction.upper_bound
      • SpeciesInjectionAction
        • SpeciesInjectionAction.apply()
        • SpeciesInjectionAction.species_id
  • epyt_control.envs.rl_env
    • RlEnv
      • RlEnv.action_space
      • RlEnv.observation_space
      • RlEnv.reset()
      • RlEnv.step()
  • epyt_control.envs.hydraulic_control_env
    • EpanetControlEnv
    • HydraulicControlEnv
    • MultiConfigEpanetControlEnv
      • MultiConfigEpanetControlEnv.reset()
    • MultiConfigHydraulicControlEnv
  • epyt_control.envs.advanced_quality_control_env
    • AdvancedQualityControlEnv
    • EpanetMsxControlEnv
      • EpanetMsxControlEnv.reset()
    • MultiConfigAdvancedQualityControlEnv
    • MultiConfigEpanetMsxControlEnv
      • MultiConfigEpanetMsxControlEnv.reset()
• epyt_control.controllers
  • epyt_control.controllers.pid
    • PidController
      • PidController.action_lower_bound
      • PidController.action_upper_bound
      • PidController.derivative_gain
      • PidController.integral_gain
      • PidController.proportional_gain
      • PidController.step()
      • PidController.target_value
  • epyt_control.controllers.lqr
    • linear_quadratic_regulator()
    • time_varying_lqr()
• epyt_control.signal_processing
  • epyt_control.signal_processing.state_estimation
    • epyt_control.signal_processing.state_estimation.kalman_filters
      • ExtendedKalmanFilter
        • ExtendedKalmanFilter.init_state_uncertainty_cov
        • ExtendedKalmanFilter.measurement_func
        • ExtendedKalmanFilter.measurement_func_grad
        • ExtendedKalmanFilter.measurement_uncertainty_cov
        • ExtendedKalmanFilter.reset()
        • ExtendedKalmanFilter.state_transition_func
        • ExtendedKalmanFilter.state_transition_func_grad
        • ExtendedKalmanFilter.step()
        • ExtendedKalmanFilter.system_uncertainty_cov
      • KalmanFilter
        • KalmanFilter.init_state_uncertainty_cov
        • KalmanFilter.measurement_func
        • KalmanFilter.measurement_uncertainty_cov
        • KalmanFilter.reset()
        • KalmanFilter.state_transition_func
        • KalmanFilter.step()
        • KalmanFilter.system_uncertainty_cov
      • KalmanFilterBase
        • KalmanFilterBase.init_state
        • KalmanFilterBase.obs_dim
        • KalmanFilterBase.reset()
        • KalmanFilterBase.state_dim
        • KalmanFilterBase.step()
      • TimeVaryingExtendedKalmanFilter
        • TimeVaryingExtendedKalmanFilter.reset()
        • TimeVaryingExtendedKalmanFilter.step()
      • TimeVaryingKalmanFilter
        • TimeVaryingKalmanFilter.reset()
        • TimeVaryingKalmanFilter.step()
    • epyt_control.signal_processing.state_estimation.smoothers
      • RauchTungStriebelSmoother
        • RauchTungStriebelSmoother.step()
        • RauchTungStriebelSmoother.time_window_length
      • TimeVaryingRauchTungStriebelSmoother
        • TimeVaryingRauchTungStriebelSmoother.step()
        • TimeVaryingRauchTungStriebelSmoother.time_window_length
  • epyt_control.signal_processing.state_forecasting
    • epyt_control.signal_processing.state_forecasting.surrogates
      • HydraulicStateTransitionSurrogate
        • HydraulicStateTransitionSurrogate.fit_to_scada()
        • HydraulicStateTransitionSurrogate.predict()
      • StateTransitionModel
        • StateTransitionModel.fit()
        • StateTransitionModel.init()
        • StateTransitionModel.partial_fit()
        • StateTransitionModel.predict()
      • StateTransitionSurrogate
        • StateTransitionSurrogate.fit_to_env()
        • StateTransitionSurrogate.fit_to_scada()
      • WaterQualityStateTransitionSurrogate
        • WaterQualityStateTransitionSurrogate.fit_to_scada()
        • WaterQualityStateTransitionSurrogate.predict()
    • epyt_control.signal_processing.state_forecasting.mlp_surrogate
      • DnnStateTransitionModel
        • DnnStateTransitionModel.compute_jacobian()
        • DnnStateTransitionModel.fit()
        • DnnStateTransitionModel.init()
        • DnnStateTransitionModel.invert_output_scaling()
        • DnnStateTransitionModel.load_from_file()
        • DnnStateTransitionModel.partial_fit()
        • DnnStateTransitionModel.predict()
        • DnnStateTransitionModel.save_to_file()
      • SimpleMlpStateTransitionModel
        • SimpleMlpStateTransitionModel.fit()
        • SimpleMlpStateTransitionModel.init()
        • SimpleMlpStateTransitionModel.partial_fit()
        • SimpleMlpStateTransitionModel.predict()
  • epyt_control.signal_processing.event_detection
    • epyt_control.signal_processing.event_detection.event_detector
      • EventDetector
        • EventDetector.apply()
    • epyt_control.signal_processing.event_detection.sensor_interpolation_detector
      • SensorInterpolationDetector
        • SensorInterpolationDetector.apply()
        • SensorInterpolationDetector.fit()
        • SensorInterpolationDetector.regressor_type
        • SensorInterpolationDetector.regressors
• epyt_control.evaluation
  • epyt_control.evaluation.evaluation
    • evaluate_policy()
  • epyt_control.evaluation.metrics
    • accuracy_score()
    • f1_micro_score()
    • f1_score()
    • mape()
    • mase()
    • mean_squared_error()
    • precision_score()
    • r2_score()
    • roc_auc_score()
    • running_mse()
    • running_r2_score()
    • smape()
    • true_negative_rate()
    • true_positive_rate()