review suggestions

Author: MarleneBusch

examples/hyperparameter_optimization/generate_plots.py

@@ -25,10 +25,9 @@ def plot_kinematics_reconstruction_fluxes(
     reconstruction_results: dict[str, dict[str, Any]], save_dir: pathlib.Path
 ) -> None:
     """
-    Plot the distribution of reconstruction errors.
+    Plot kinematic reconstruction flux comparison.
 
-    This function plots histograms and kernel density estimations of the pointing errors in reconstruction when comparing
-    HeliOS and UTIS as methods for focal spot centroid extraction.
+    The measured fluxes, fluxes with default kinematics and reconstructed kinematics are plotted side by side.
 
     Parameters
     ----------
@@ -316,10 +315,7 @@ def plot_motor_pos_fluxes(
     reconstruction_results: dict[str, Any], save_dir: pathlib.Path
 ) -> None:
     """
-    Plot the distribution of reconstruction errors.
-
-    This function plots histograms and kernel density estimations of the pointing errors in reconstruction when comparing
-    HeliOS and UTIS as methods for focal spot centroid extraction.
+    Plot the flux comparison of the optimized and unoptimized fluxes.
 
     Parameters
     ----------

examples/hyperparameter_optimization/generate_results_motor_position.py

@@ -1,3 +1,22 @@
+"""
+Generate results with the optimized parameters.
+
+Parameters
+----------
+config : str
+    Path to the configuration file.
+device : str
+    Device to use for the computation.
+data_dir : str
+    Path to the data directory.
+heliostat_for_reconstruction : dict[str, list[int]]
+    The heliostat and its calibration numbers.
+results_dir : str
+    Path to where the results will be saved.
+scenarios_dir : str
+    Path to the directory containing the scenarios.
+"""
+
 import argparse
 import json
 import pathlib
@@ -277,24 +296,6 @@ def generate_reconstruction_results(
 
 
 if __name__ == "__main__":
-    """
-    Generate results with the optimized parameters.
-
-    Parameters
-    ----------
-    config : str
-        Path to the configuration file.
-    device : str
-        Device to use for the computation.
-    data_dir : str
-        Path to the data directory.
-    heliostat_for_reconstruction : dict[str, list[int]]
-        The heliostat and its calibration numbers.
-    results_dir : str
-        Path to where the results will be saved.
-    scenarios_dir : str
-        Path to the directory containing the scenarios.
-    """
     # Set default location for configuration file.
     script_dir = pathlib.Path(__file__).resolve().parent
     default_config_path = script_dir / "config.yaml"

examples/hyperparameter_optimization/generate_scenarios.py

@@ -1,3 +1,25 @@
+"""
+Generate scenarios for the hyperparameter optimizations.
+
+This will generate ideal surface scenarios for the hyperparameter searches.
+For the surface evaluation a deflectometry scenario will also be created.
+
+Parameters
+----------
+config : str
+    Path to the configuration file.
+device : str
+    Device to use for the computation.
+data_dir : str
+    Path to the data directory.
+tower_file_name : str
+    Name of the file containing the tower measurements.
+results_dir : str
+    Path to the results directory containing the viable heliostats list.
+scenarios_dir : str
+    Path to the directory for saving the generated scenarios.
+"""
+
 import argparse
 import json
 import pathlib
@@ -173,15 +195,15 @@ def generate_ideal_scenario(
     )
 
     # Set up light source configuration.
-    light_source1_config = LightSourceConfig(
+    light_source_config = LightSourceConfig(
         light_source_key="sun_1",
         light_source_type=config_dictionary.sun_key,
         number_of_rays=10,
         distribution_type=config_dictionary.light_source_distribution_is_normal,
         mean=0.0,
         covariance=4.3681e-06,
     )
-    light_source_list = [light_source1_config]
+    light_source_list = [light_source_config]
     light_source_list_config = LightSourceListConfig(
         light_source_list=light_source_list
     )
@@ -321,27 +343,6 @@ def generate_fitted_scenario(
 
 
 if __name__ == "__main__":
-    """
-    Generate scenarios for the hyperparameter optimizations.
-
-    This will generate ideal surface scenarios for the hyperparameter searches.
-    For the surface evaluation a deflectometry scenario will also be created.
-
-    Parameters
-    ----------
-    config : str
-        Path to the configuration file.
-    device : str
-        Device to use for the computation.
-    data_dir : str
-        Path to the data directory.
-    tower_file_name : str
-        Name of the file containing the tower measurements.
-    results_dir : str
-        Path to the results directory containing the viable heliostats list.
-    scenarios_dir : str
-        Path to the directory for saving the generated scenarios.
-    """
     # Set default location for configuration file.
     script_dir = pathlib.Path(__file__).resolve().parent
     default_config_path = script_dir / "config.yaml"

examples/hyperparameter_optimization/generate_viable_heliostats_list.py

@@ -1,3 +1,27 @@
+"""
+Generate list of viable heliostats for the hyperparameter optimizations.
+
+This script identifies a list of viable heliostats, i.e., containing a minimum number of valid measurements, for
+the optimization process.
+
+Parameters
+----------
+config : str
+    Path to the configuration file.
+device : str
+    Device to use for the computation.
+data_dir : str
+    Path to the data directory.
+results_dir : str
+    Path to where the results will be saved.
+minimum_number_of_measurements : int
+    Minimum number of calibration measurements per heliostat required.
+kinematics_reconstruction_image_type : str
+    Type of calibration image to use for the kinematics reconstruction, i.e., flux or flux-centered.
+surface_reconstruction_image_type : str
+    Type of calibration image to use for the surface reconstruction, i.e., flux or flux-centered.
+"""
+
 import argparse
 import json
 import pathlib
@@ -151,29 +175,6 @@ def find_viable_heliostats(
 
 
 if __name__ == "__main__":
-    """
-    Generate list of viable heliostats for the hyperparameter optimizations.
-
-    This script identifies a list of viable heliostats, i.e., containing a minimum number of valid measurements, for
-    the optimization process.
-
-    Parameters
-    ----------
-    config : str
-        Path to the configuration file.
-    device : str
-        Device to use for the computation.
-    data_dir : str
-        Path to the data directory.
-    results_dir : str
-        Path to where the results will be saved.
-    minimum_number_of_measurements : int
-        Minimum number of calibration measurements per heliostat required.
-    kinematics_reconstruction_image_type : str
-        Type of calibration image to use for the kinematics reconstruction, i.e., flux or flux-centered.
-    surface_reconstruction_image_type : str
-        Type of calibration image to use for the surface reconstruction, i.e., flux or flux-centered.
-    """
     # Set default location for configuration file.
     script_dir = pathlib.Path(__file__).resolve().parent
     default_config_path = script_dir / "config.yaml"

examples/hyperparameter_optimization/search_kinematic_reconstruction.py

@@ -1,3 +1,29 @@
+"""
+Perform the hyperparameter search for the kinematics reconstruction and save the results.
+
+This script executes the hyperparameter search with ``propulate`` and saves the result for
+further inspection.
+
+Parameters
+----------
+config : str
+    Path to the configuration file.
+device : str
+    Device to use for the computation.
+data_dir : str
+    Path to the data directory.
+heliostat_for_reconstruction : dict[str, list[int]]
+    The heliostat and its calibration numbers.
+results_dir : str
+    Path to where the results will be saved.
+scenarios_dir : str
+    Path to the directory containing the scenarios.
+propulate_logs_dir : str
+    Path to the directory where propulate will write log messages.
+parameter_ranges_kinematics : dict[str, int | float]
+    The reconstruction parameters.
+"""
+
 import argparse
 import json
 import logging
@@ -24,7 +50,7 @@
 from artist.util.environment_setup import get_device
 
 log = logging.getLogger(__name__)
-"""A logger for the hyper parameter search."""
+"""A logger for the hyperparameter search."""
 
 
 def kinematics_reconstructor_for_hpo(
@@ -145,31 +171,6 @@ def kinematics_reconstructor_for_hpo(
 
 
 if __name__ == "__main__":
-    """
-    Perform the hyperparameter search for the kinematics reconstruction and save the results.
-
-    This script executes the hyperparameter search with ``propulate`` and saves the result for
-    further inspection.
-
-    Parameters
-    ----------
-    config : str
-        Path to the configuration file.
-    device : str
-        Device to use for the computation.
-    data_dir : str
-        Path to the data directory.
-    heliostat_for_reconstruction : dict[str, list[int]]
-        The heliostat and its calibration numbers.
-    results_dir : str
-        Path to where the results will be saved.
-    scenarios_dir : str
-        Path to the directory containing the scenarios.
-    propulate_logs_dir : str
-        Path to the directory where propulate will write log messages.
-    parameter_ranges_kinematics : dict[str, int | float]
-        The reconstruction parameters.
-    """
     comm = MPI.COMM_WORLD
 
     rank = comm.Get_rank()
@@ -291,7 +292,6 @@ def kinematics_reconstructor_for_hpo(
     )
 
     log = logging.getLogger(__name__)
-    rank = comm.Get_rank()
     log.info(rank)
 
     seed = 7
@@ -378,10 +378,10 @@ def kinematics_reconstructor_for_hpo(
     hpo_result_file = propulate_logs_dir / "island_0_ckpt.pickle"
     optimized_parameters_file = results_dir / "hpo_results_kinematics.json"
 
-    # Save hpo results in format to be used by plots.
+    # Save HPO results in format to be used by plots.
     if not hpo_result_file.exists():
         raise FileNotFoundError(
-            f"The hpo results located at {hpo_result_file} could not be not found! Please run the hpo script again to generate the results."
+            f"The HPO results located at {hpo_result_file} could not be not found! Please run the HPO script again to generate the results."
         )
 
     with open(hpo_result_file, "rb") as results:

examples/hyperparameter_optimization/search_motor_position_optimization.py

@@ -1,3 +1,27 @@
+"""
+Perform the hyperparameter search for the motor position optimization and save the results.
+
+This script executes the hyperparameter search with ``propulate`` and saves the result for
+further inspection.
+
+Parameters
+----------
+config : str
+    Path to the configuration file.
+device : str
+    Device to use for the computation.
+data_dir : str
+    Path to the data directory.
+results_dir : str
+    Path to where the results will be saved.
+scenarios_dir : str
+    Path to the directory containing the scenarios.
+propulate_logs_dir : str
+    Path to the directory where propulate will write log messages.
+parameter_ranges_motor_positions : dict[str, str | int | float]
+    The reconstruction parameters.
+"""
+
 import argparse
 import json
 import logging
@@ -22,7 +46,7 @@
 from artist.util.environment_setup import get_device
 
 log = logging.getLogger(__name__)
-"""A logger for the hyper parameter search."""
+"""A logger for the hyperparameter search."""
 
 
 def motor_position_optimizer_for_hpo(
@@ -153,29 +177,6 @@ def motor_position_optimizer_for_hpo(
 
 
 if __name__ == "__main__":
-    """
-    Perform the hyperparameter search for the motor position optimization and save the results.
-
-    This script executes the hyperparameter search with ``propulate`` and saves the result for
-    further inspection.
-
-    Parameters
-    ----------
-    config : str
-        Path to the configuration file.
-    device : str
-        Device to use for the computation.
-    data_dir : str
-        Path to the data directory.
-    results_dir : str
-        Path to where the results will be saved.
-    scenarios_dir : str
-        Path to the directory containing the scenarios.
-    propulate_logs_dir : str
-        Path to the directory where propulate will write log messages.
-    parameter_ranges_motor_positions : dict[str, str | int | float]
-        The reconstruction parameters.
-    """
     comm = MPI.COMM_WORLD
 
     rank = comm.Get_rank()
@@ -364,10 +365,10 @@ def motor_position_optimizer_for_hpo(
     hpo_result_file = propulate_logs_dir / "island_0_ckpt.pickle"
     optimized_parameters_file = results_dir / "hpo_results_motor_positions.json"
 
-    # Save hpo results in format to be used by plots.
+    # Save HPO results in format to be used by plots.
     if not hpo_result_file.exists():
         raise FileNotFoundError(
-            f"The hpo results located at {hpo_result_file} could not be not found! Please run the hpo script again to generate the results."
+            f"The HPO results located at {hpo_result_file} could not be not found! Please run the HPO script again to generate the results."
         )
 
     with open(hpo_result_file, "rb") as results:

examples/hyperparameter_optimization/search_surface_reconstruction.py

@@ -25,7 +25,7 @@
 from artist.util.environment_setup import get_device
 
 log = logging.getLogger(__name__)
-"""A logger for the hyper parameter search."""
+"""A logger for the hyperparameter search."""
 
 
 def surface_reconstructor_for_hpo(
@@ -442,10 +442,10 @@ def surface_reconstructor_for_hpo(
     hpo_result_file = propulate_logs_dir / "island_0_ckpt.pickle"
     optimized_parameters_file = results_dir / "hpo_results_surface.json"
 
-    # Save hpo results in format to be used by plots.
+    # Save HPO results in format to be used by plots.
     if not hpo_result_file.exists():
         raise FileNotFoundError(
-            f"The hpo results located at {hpo_result_file} could not be not found! Please run the hpo script again to generate the results."
+            f"The HPO results located at {hpo_result_file} could not be not found! Please run the HPO script again to generate the results."
         )
 
     with open(hpo_result_file, "rb") as results: