epyt-flow 0.8.0__tar.gz → 0.9.0__tar.gz

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: epyt-flow
-Version: 0.8.0
+Version: 0.9.0
 Summary: EPyT-Flow -- EPANET Python Toolkit - Flow
 Author-email: André Artelt <aartelt@techfak.uni-bielefeld.de>, "Marios S. Kyriakou" <kiriakou.marios@ucy.ac.cy>, "Stelios G. Vrachimis" <vrachimis.stelios@ucy.ac.cy>
 License: MIT License

epyt_flow-0.9.0/epyt_flow/VERSION

@@ -0,0 +1 @@
+0.9.0

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/__init__.py

@@ -6,6 +6,7 @@ import os
 
 with open(os.path.join(os.path.dirname(__file__), 'VERSION'), encoding="utf-8") as f:
     VERSION = f.read().strip()
+    __version__ = VERSION
 
 
 def compile_libraries_unix(lib_epanet_name: str, compile_script_name: str,

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/data/benchmarks/batadal.py

@@ -91,7 +91,7 @@ def load_data(download_dir: str = None, return_X_y: bool = False,
     `dict`
         Dictionary of the loaded benchmark data. The dictionary contains the two training
         data sets ("train_1" and "train_2"), as well as the test data set ("test").
-        If `return_X_y` is False, each dictionary entry is a Pandas dataframe.
+        If `return_X_y` is False, each dictionary entry is a `Pandas dataframe <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html>`_.
         Otherwise, it is a tuple of sensor readings and labels (except for the test set) --
         if `return_ground_truth` is True or `return_features_desc` is True, the corresponding
         data is appended to the tuple.

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/data/benchmarks/battledim.py

@@ -286,7 +286,7 @@ def load_data(return_test_scenario: bool, download_dir: str = None, return_X_y:
 
     Returns
     -------
-    Either a `pandas.DataFrame` instance or a tuple of Numpy arrays.
+    Either a `pandas.DataFrame <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html>`_ instance or a tuple of `Numpy arrays <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_.
         Benchmark data set.
     """
     # Download data files if necessary
@@ -389,8 +389,9 @@ def load_scada_data(return_test_scenario: bool, download_dir: str = None,
     :class:`~epyt_flow.simulation.scada.scada_data.ScadaData` or `list[tuple[numpy.ndarray, numpy.ndarray]]`
         The simulated benchmark scenario as either a
         :class:`~epyt_flow.simulation.scada.scada_data.ScadaData` instance or as a tuple of
-        (X, y) Numpy arrays. If 'return_leak_locations' is True, the leak locations are included
-        as an instance of `scipy.sparse.bsr_array` as well.
+        (X, y) `Numpy arrays <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_.
+        If 'return_leak_locations' is True, the leak locations are included
+        as an instance of `scipy.sparse.bsr_array <https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.bsr_array.html>`_ as well.
     """
     download_dir = download_dir if download_dir is not None else get_temp_folder()
 

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/data/benchmarks/gecco_water_quality.py

@@ -31,9 +31,9 @@ def compute_evaluation_score(y_pred: np.ndarray, y: np.ndarray) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Event indication prediction over time
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth event indication over time.
 
     Returns
@@ -85,7 +85,7 @@ def load_gecco2017_water_quality_data(download_dir: str = None, return_X_y: bool
 
     Returns
     -------
-    `pandas.DataFrame` or `tuple[numpy.ndarray, numpy.ndarray]`
+    `pandas.DataFrame <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html>`_ or `tuple[numpy.ndarray, numpy.ndarray] <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         The benchmark data set as either a Pandas data frame or as a pair of (X, y) Numpy arrays.
     """
     url_data = "https://zenodo.org/records/3884465/files/1_gecco2017_water_quality.csv?download=1"
@@ -154,7 +154,7 @@ def load_gecco2018_water_quality_data(download_dir: str = None, return_X_y: bool
 
     Returns
     -------
-    `pandas.DataFrame` or `tuple[numpy.ndarray, numpy.ndarray]`
+    `pandas.DataFrame <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html>`_ or `tuple[numpy.ndarray, numpy.ndarray] <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         The benchmark data set as either a Pandas data frame or as a pair of (X, y) Numpy arrays.
     """
     # Download data if necessary

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/data/benchmarks/leakdb.py

@@ -97,7 +97,7 @@ def compute_evaluation_score(scenarios_id: list[int], use_net1: bool,
         List of scenarios ID that are to be evaluated -- there is a total number of 1000 scenarios.
     use_net1 : `bool`
         If True, Net1 LeakDB will be used for evaluation, otherwise the Hanoi LeakDB will be used.
-    y_pred_labels_per_scenario : `list[numpy.ndarray]`
+    y_pred_labels_per_scenario : `list[numpy.ndarray] <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted binary labels (over time) for each scenario in `scenarios_id`.
 
     Returns
@@ -201,7 +201,7 @@ def load_data(scenarios_id: list[int], use_net1: bool, download_dir: str = None,
         The default is False.
     return_leak_locations : `bool`
         If True and if `return_X_y` is True, the leak locations are returned as well --
-        as an instance of `scipy.sparse.bsr_array`.
+        as an instance of `scipy.sparse.bsr_array <https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.bsr_array.html>`_.
 
         The default is False.
     verbose : `bool`, optional
@@ -327,7 +327,7 @@ def load_scada_data(scenarios_id: list[int], use_net1: bool = True, download_dir
         The default is False.
     return_leak_locations : `bool`
         If True, the leak locations are returned as well --
-        as an instance of `scipy.sparse.bsr_array`.
+        as an instance of `scipy.sparse.bsr_array <https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.bsr_array.html>`_.
 
         The default is False.
     verbose : `bool`, optional
@@ -341,7 +341,7 @@ def load_scada_data(scenarios_id: list[int], use_net1: bool = True, download_dir
         The simulated benchmark scenarios as either a list of
         :class:`~epyt_flow.simulation.scada.scada_data.ScadaData` instances or as a list of
         (X, y) Numpy arrays. If 'return_leak_locations' is True, the leak locations are included
-        as an instance of `scipy.sparse.bsr_array` as well.
+        as an instance of `scipy.sparse.bsr_array <https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.bsr_array.html>`_ as well.
     """
     download_dir = download_dir if download_dir is not None else get_temp_folder()
 
@@ -491,9 +491,9 @@ def load_scenarios(scenarios_id: list[int], use_net1: bool = True,
 
         return dem_final
 
-    week_pattern_url = "https://github.com/KIOS-Research/LeakDB/raw/master/CCWI-WDSA2018/" +\
+    week_pattern_url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/CCWI-WDSA2018/" +\
         "Dataset_Generator_Py3/weekPat_30min.mat"
-    year_offset_url = "https://github.com/KIOS-Research/LeakDB/raw/master/CCWI-WDSA2018/" +\
+    year_offset_url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/CCWI-WDSA2018/" +\
         "Dataset_Generator_Py3/yearOffset_30min.mat"
 
     download_if_necessary(os.path.join(download_dir, "weekPat_30min.mat"),
@@ -544,9 +544,9 @@ def load_scenarios(scenarios_id: list[int], use_net1: bool = True,
             upper = data + z
             return lower + np.random.uniform() * (upper - lower)
 
-    my_uncertainties = {"pipe_length_uncertainty": MyUniformUncertainty(low=0, high=0.25),
-                        "pipe_roughness_uncertainty": MyUniformUncertainty(low=0, high=0.25),
-                        "base_demand_uncertainty": MyUniformUncertainty(low=0, high=0.25)}
+    my_uncertainties = {"global_pipe_length_uncertainty": MyUniformUncertainty(low=0, high=0.25),
+                        "global_pipe_roughness_uncertainty": MyUniformUncertainty(low=0, high=0.25),
+                        "global_base_demand_uncertainty": MyUniformUncertainty(low=0, high=0.25)}
     model_uncertainty = ModelUncertainty(**my_uncertainties)
 
     # Create sensor config (place pressure and flow sensors everywhere)

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/data/benchmarks/water_usage.py

@@ -22,9 +22,9 @@ def compute_evaluation_score(y_pred: np.ndarray, y: np.ndarray) -> dict:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Event indication prediction over time
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth event indication over time.
 
     Returns

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/data/networks.py

@@ -102,7 +102,7 @@ def load_inp(f_in: str, include_empty_sensor_config: bool = True,
         Scenario configuration for the .inp file.
     """
     if not os.path.isfile(f_in):
-        raise ValueError("Can not find 'f_in'")
+        raise ValueError(f"Can not find {f_in}")
 
     if include_empty_sensor_config is True:
         return ScenarioConfig(f_inp_in=f_in, sensor_config=create_empty_sensor_config(f_inp=f_in),
@@ -153,8 +153,7 @@ def load_net1(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "Net1.inp")
-    url = "https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/main/epyt/networks/" + \
-          "asce-tf-wdst/Net1.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Net1.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -201,8 +200,7 @@ def load_net2(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "Net2.inp")
-    url = "https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/main/epyt/networks/" + \
-          "asce-tf-wdst/Net2.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Net2.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -249,8 +247,7 @@ def load_net3(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "Net3.inp")
-    url = "https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/main/epyt/networks/" + \
-          "asce-tf-wdst/Net3.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Net3.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -297,7 +294,7 @@ def load_net6(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "Net6.inp")
-    url = "https://github.com/OpenWaterAnalytics/WNTR/raw/main/examples/networks/Net6.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Net6.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -344,8 +341,7 @@ def load_richmond(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "Richmond_standard.inp")
-    url = "https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/main/epyt/networks/" + \
-          "exeter-benchmarks/Richmond_standard.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Richmond_standard.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -392,8 +388,7 @@ def load_micropolis(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "MICROPOLIS_v1.inp")
-    url = "https://github.com/OpenWaterAnalytics/EPyT/raw/main/epyt/networks/asce-tf-wdst/" + \
-          "MICROPOLIS_v1.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/MICROPOLIS_v1.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -440,8 +435,7 @@ def load_balerma(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "Balerma.inp")
-    url = "https://github.com/OpenWaterAnalytics/EPyT/raw/main/epyt/networks/" + \
-          "asce-tf-wdst/Balerma.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Balerma.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -488,8 +482,7 @@ def load_rural(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "RuralNetwork.inp")
-    url = "https://github.com/OpenWaterAnalytics/EPyT/raw/main/epyt/networks/" + \
-          "asce-tf-wdst/RuralNetwork.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/RuralNetwork.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -536,8 +529,7 @@ def load_bwsn1(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "BWSN_Network_1.inp")
-    url = "https://github.com/OpenWaterAnalytics/EPyT/raw/main/epyt/networks/" + \
-          "asce-tf-wdst/BWSN_Network_1.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/BWSN_Network_1.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -584,8 +576,7 @@ def load_bwsn2(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "BWSN_Network_2.inp")
-    url = "https://github.com/OpenWaterAnalytics/EPyT/raw/main/epyt/networks/" + \
-          "asce-tf-wdst/BWSN_Network_2.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/BWSN_Network_2.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -632,8 +623,7 @@ def load_anytown(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "Anytown.inp")
-    url = "https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/main/epyt/networks/" + \
-          "asce-tf-wdst/Anytown.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Anytown.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -727,7 +717,7 @@ def load_ctown(download_dir: str = get_temp_folder(), verbose: bool = True,
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "CTOWN.INP")
-    url = "https://github.com/scy-phy/www.batadal.net/raw/master/data/CTOWN.INP"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/CTOWN.INP"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -783,8 +773,7 @@ def load_kentucky(wdn_id: int = 1, download_dir: str = get_temp_folder(),
         raise ValueError(f"Unknown network 'ky{wdn_id}.inp'")
 
     f_in = os.path.join(download_dir, f"ky{wdn_id}.inp")
-    url = "https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/main/epyt/networks/" + \
-          f"asce-tf-wdst/ky{wdn_id}.inp"
+    url = f"https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/ky{wdn_id}.inp"
 
     download_if_necessary(f_in, url, verbose)
     return load_inp(f_in, flow_units_id=flow_units_id)
@@ -836,8 +825,7 @@ def load_hanoi(download_dir: str = get_temp_folder(),
         :class:`~epyt_flow.simulation.scenario_simulator.ScenarioSimulator`.
     """
     f_in = os.path.join(download_dir, "Hanoi.inp")
-    url = "https://raw.githubusercontent.com/OpenWaterAnalytics/EPyT/main/epyt/networks/" + \
-          "asce-tf-wdst/Hanoi.inp"
+    url = "https://filedn.com/lumBFq2P9S74PNoLPWtzxG4/EPyT-Flow/Networks/Hanoi.inp"
 
     download_if_necessary(f_in, url, verbose)
     config = load_inp(f_in, flow_units_id=flow_units_id)

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/gym/control_gyms.py

@@ -15,7 +15,7 @@ def register(env_name: str, env: ScenarioControlEnv) -> None:
     ----------
     env_name : `str`
         Name of the environment -- must be unique among all environments.
-    env : :class:`epyt_flow.gym.scenario_control_env.ScenarioControlEnv`
+    env : :class:`~epyt_flow.gym.scenario_control_env.ScenarioControlEnv`
         Environment.
     """
     if env_name in environments:
@@ -38,7 +38,7 @@ def make(env_name: str, **kwds) -> ScenarioControlEnv:
 
     Returns
     -------
-    :class:`epyt_flow.gym.scenario_control_env.ScenarioControlEnv`
+    :class:`~epyt_flow.gym.scenario_control_env.ScenarioControlEnv`
         Environment.
     """
     if env_name not in environments:

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/gym/scenario_control_env.py

@@ -194,7 +194,7 @@ class ScenarioControlEnv(ABC):
         if pattern_idx == 0:
             warnings.warn(f"No pattern for pump '{pump_id}' found -- a new pattern is created")
             pattern_idx = self._scenario_sim.epanet_api.addPattern(f"pump_speed_{pump_id}")
-            self._scenario_sim.epanet_api.setLinkPumpPatternIndex(pattern_idx)
+            self._scenario_sim.epanet_api.setLinkPumpPatternIndex(pump_idx, pattern_idx)
 
         self._scenario_sim.epanet_api.setPattern(pattern_idx, np.array([speed]))
 

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/metrics.py

@@ -12,9 +12,9 @@ def r2_score(y_pred: np.ndarray, y: np.ndarray) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted outputs.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth outputs.
 
     Returns
@@ -31,9 +31,9 @@ def running_r2_score(y_pred: np.ndarray, y: np.ndarray) -> list[float]:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted outputs.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth outputs.
 
     Returns
@@ -55,9 +55,9 @@ def mean_squared_error(y_pred: np.ndarray, y: np.ndarray) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted outputs.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth outputs.
 
     Returns
@@ -74,9 +74,9 @@ def running_mse(y_pred: np.ndarray, y: np.ndarray) -> list[float]:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted outputs.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth outputs.
 
     Returns
@@ -112,9 +112,9 @@ def mape(y_pred: np.ndarray, y: np.ndarray, epsilon: float = .05) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted outputs.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth outputs.
     epsilon : `float`, optional
         Small number added to predictions and ground truth to avoid division-by-zero.
@@ -153,9 +153,9 @@ def smape(y_pred: np.ndarray, y: np.ndarray, epsilon: float = .05) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted outputs.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth outputs.
     epsilon : `float`, optional
         Small number added to predictions and ground truth to avoid division-by-zero.
@@ -194,9 +194,9 @@ def mase(y_pred: np.ndarray, y: np.ndarray, epsilon: float = .05) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted outputs.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth outputs.
     epsilon : `float`, optional
         Small number added to predictions and ground truth to avoid division-by-zero.
@@ -242,9 +242,9 @@ def f1_micro_score(y_pred: np.ndarray, y: np.ndarray) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted labels.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth labels.
 
     Returns
@@ -270,9 +270,9 @@ def roc_auc_score(y_pred: np.ndarray, y: np.ndarray) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted labels.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth labels.
 
     Returns
@@ -298,9 +298,9 @@ def true_positive_rate(y_pred: np.ndarray, y: np.ndarray) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted labels.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth labels.
 
     Returns
@@ -335,9 +335,9 @@ def true_negative_rate(y_pred: np.ndarray, y: np.ndarray) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted labels.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth labels.
 
     Returns
@@ -372,9 +372,9 @@ def precision_score(y_pred: np.ndarray, y: np.ndarray) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted labels.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth labels.
 
     Returns
@@ -405,9 +405,9 @@ def accuracy_score(y_pred: np.ndarray, y: np.ndarray) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted labels.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth labels.
 
     Returns
@@ -434,9 +434,9 @@ def f1_score(y_pred: np.ndarray, y: np.ndarray) -> float:
 
     Parameters
     ----------
-    y_pred : `numpy.ndarray`
+    y_pred : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Predicted labels.
-    y : `numpy.ndarray`
+    y : `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
         Ground truth labels.
 
     Returns

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/models/sensor_interpolation_detector.py

@@ -20,7 +20,7 @@ class SensorInterpolationDetector(EventDetector):
         Regressor class that will be used for the sensor interpolation.
         Must implement the usual `fit` and `predict` functions.
 
-        The default is `sklearn.linear_model.LinearRegression`
+        The default is `sklearn.linear_model.LinearRegression <https://scikit-learn.org/dev/modules/generated/sklearn.linear_model.LinearRegression.html>`_
     """
     def __init__(self, regressor_type: Any = LinearRegression, **kwds):
         self.__regressor_type = regressor_type
@@ -63,7 +63,7 @@ class SensorInterpolationDetector(EventDetector):
 
         Parameters
         ----------
-        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData` or `numpy.ndarray`
+        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData` or `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             SCADA data to fit this detector.
         """
         if isinstance(scada_data, ScadaData):
@@ -93,7 +93,7 @@ class SensorInterpolationDetector(EventDetector):
 
         Parameters
         ----------
-        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData` or `numpy.ndarray`
+        scada_data : :class:`~epyt_flow.simulation.scada.scada_data.ScadaData` or `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_
             SCADA data in which to look for events/anomalies.
 
         Returns

{epyt_flow-0.8.0 → epyt_flow-0.9.0}/epyt_flow/rest_api/base_handler.py

@@ -17,7 +17,7 @@ class BaseHandler():
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         error_msg : `str`
             Error message.
@@ -43,7 +43,7 @@ class BaseHandler():
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         """
         resp.status = falcon.HTTP_BAD_REQUEST
@@ -55,7 +55,7 @@ class BaseHandler():
 
         Parameters
         ----------
-        req : `falcon.Request`
+        req : `falcon.Request <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#request>`_
             Request instance.
 
         Returns
@@ -74,7 +74,7 @@ class BaseHandler():
 
         Parameters
         ----------
-        resp : `falcon.Response`
+        resp : `falcon.Response <https://falcon.readthedocs.io/en/stable/api/request_and_response_asgi.html#response>`_
             Response instance.
         data : `Any`
             Data to be sent.