job-shop-lib 1.0.0a2__py3-none-any.whl → 1.0.0a4__py3-none-any.whl

job_shop_lib/graphs/graph_updaters/_graph_updater.py

@@ -23,6 +23,17 @@ class GraphUpdater(DispatcherObserver):
         job_shop_graph:
             The current job shop graph. This is the graph that is updated
             after each scheduled operation.
+
+    Args:
+        dispatcher:
+            The dispatcher instance to observe.
+        job_shop_graph:
+            The job shop graph to update.
+        subscribe:
+            Whether to subscribe to the dispatcher. If ``True``, the
+            observer will subscribe to the dispatcher when it is
+            initialized. If ``False``, the observer will not subscribe
+            to the dispatcher.
     """
 
     def __init__(
@@ -32,19 +43,6 @@ class GraphUpdater(DispatcherObserver):
         *,
         subscribe: bool = True,
     ):
-        """Initializes the class.
-
-        Args:
-            dispatcher:
-                The dispatcher instance to observe.
-            job_shop_graph:
-                The job shop graph to update.
-            subscribe:
-                Whether to subscribe to the dispatcher. If ``True``, the
-                observer will subscribe to the dispatcher when it is
-                initialized. If ``False``, the observer will not subscribe
-                to the dispatcher.
-        """
         super().__init__(dispatcher, subscribe=subscribe)
         self.initial_job_shop_graph = deepcopy(job_shop_graph)
         self.job_shop_graph = job_shop_graph

job_shop_lib/graphs/graph_updaters/_residual_graph_updater.py

@@ -25,9 +25,24 @@ class ResidualGraphUpdater(GraphUpdater):
 
     Attributes:
         remove_completed_machine_nodes:
-            If True, removes completed machine nodes from the graph.
+            If ``True``, removes completed machine nodes from the graph.
         remove_completed_job_nodes:
-            If True, removes completed job nodes from the graph.
+            If ``True``, removes completed job nodes from the graph.
+
+    Args:
+        dispatcher:
+            The dispatcher instance to observe.
+        job_shop_graph:
+            The job shop graph to update.
+        subscribe:
+            If ``True``, automatically subscribes the observer to the
+            dispatcher. Defaults to ``True``.
+        remove_completed_machine_nodes:
+            If ``True``, removes completed machine nodes from the graph.
+            Defaults to ``True``.
+        remove_completed_job_nodes:
+            If ``True``, removes completed job nodes from the graph.
+            Defaults to ``True``.
     """
 
     def __init__(
@@ -39,24 +54,6 @@ class ResidualGraphUpdater(GraphUpdater):
         remove_completed_machine_nodes: bool = True,
         remove_completed_job_nodes: bool = True,
     ):
-        """Initializes the residual graph updater.
-
-        Args:
-            dispatcher:
-                The dispatcher instance to observe.
-            job_shop_graph:
-                The job shop graph to update.
-            subscribe:
-                If True, automatically subscribes the observer to the
-                dispatcher. Defaults to True.
-            remove_completed_machine_nodes:
-                If True, removes completed machine nodes from the graph.
-                Defaults to True.
-            remove_completed_job_nodes:
-                If True, removes completed job nodes from the graph.
-                Defaults to True.
-        """
-
         self._is_completed_observer: None | IsCompletedObserver = None
         self.remove_completed_job_nodes = remove_completed_job_nodes
         self.remove_completed_machine_nodes = remove_completed_machine_nodes

job_shop_lib/reinforcement_learning/__init__.py

@@ -1,12 +1,24 @@
-"""Package for reinforcement learning components."""
+"""Contains reinforcement learning components.
+
+
+.. autosummary::
+
+    SingleJobShopGraphEnv
+    MultiJobShopGraphEnv
+    ObservationDict
+    ObservationSpaceKey
+    RewardObserver
+    MakespanReward
+    IdleTimeReward
+    RenderConfig
+    add_padding
+
+"""
 
 from job_shop_lib.reinforcement_learning._types_and_constants import (
     ObservationSpaceKey,
     RenderConfig,
     ObservationDict,
-    GanttChartWrapperConfig,
-    GifConfig,
-    VideoConfig,
 )
 
 from job_shop_lib.reinforcement_learning._reward_observers import (
@@ -30,9 +42,6 @@ __all__ = [
     "RewardObserver",
     "MakespanReward",
     "IdleTimeReward",
-    "GanttChartWrapperConfig",
-    "GifConfig",
-    "VideoConfig",
     "SingleJobShopGraphEnv",
     "RenderConfig",
     "ObservationDict",

job_shop_lib/reinforcement_learning/_multi_job_shop_graph_env.py

@@ -42,11 +42,11 @@ class MultiJobShopGraphEnv(gym.Env):
 
     The observation space includes:
 
-        - removed_nodes: Binary vector indicating removed nodes.
-        - edge_index: Edge list in COO format.
-        - operations: Matrix of operation features.
-        - jobs: Matrix of job features (if applicable).
-        - machines: Matrix of machine features (if applicable).
+    - removed_nodes: Binary vector indicating removed nodes.
+    - edge_index: Edge list in COO format.
+    - operations: Matrix of operation features.
+    - jobs: Matrix of job features (if applicable).
+    - machines: Matrix of machine features (if applicable).
 
     Internally, the class creates a
     :class:`~job_shop_lib.reinforcement_learning.SingleJobShopGraphEnv`
@@ -57,29 +57,37 @@ class MultiJobShopGraphEnv(gym.Env):
         instance_generator:
             A :class:`~job_shop_lib.generation.InstanceGenerator` that
             generates a new problem instance on each reset.
+
         action_space:
             :class:`gymnasium.spaces.Discrete`) action space with size equal to
             the maximum number of jobs.
+
         observation_space:
             Dictionary of observation spaces. Keys are defined in
             :class:`~job_shop_lib.reinforcement_learning.ObservationSpaceKey`.
+
         single_job_shop_graph_env:
             Environment for a specific Job Shop Scheduling Problem instance.
             See :class:`SingleJobShopGraphEnv`.
+
         graph_initializer:
             Function to create the initial graph representation. It should
             take a :class:`~job_shop_lib.JobShopInstance` as input and return
             a :class:`~job_shop_lib.graphs.JobShopGraph`.
+
         render_mode:
             Rendering mode for visualization. Supported modes are:
+
             - human: Renders the current Gannt chart.
             - save_video: Saves a video of the Gantt chart. Used only if the
               schedule is completed.
             - save_gif: Saves a GIF of the Gantt chart. Used only if the
               schedule is completed.
+
         render_config:
             Configuration for rendering. See
             :class:`~job_shop_lib.RenderConfig`.
+
         feature_observer_configs:
             List of :class:`~job_shop_lib.dispatching.DispatcherObserverConfig`
             for feature observers.
@@ -87,11 +95,63 @@ class MultiJobShopGraphEnv(gym.Env):
             Configuration for the reward function. See
             :class:`~job_shop_lib.dispatching.DispatcherObserverConfig` and
             :class:`~job_shop_lib.dispatching.RewardObserver`.
+
         graph_updater_config:
             Configuration for the graph updater. The graph updater is used to
             update the graph representation after each action. See
             :class:`~job_shop_lib.dispatching.DispatcherObserverConfig` and
             :class:`~job_shop_lib.graphs.GraphUpdater`.
+    Args:
+        instance_generator:
+            A :class:`~job_shop_lib.generation.InstanceGenerator` that
+            generates a new problem instance on each reset.
+
+        feature_observer_configs:
+            Configurations for feature observers. Each configuration
+            should be a
+            :class:`~job_shop_lib.dispatching.DispatcherObserverConfig`
+            with a class type that inherits from
+            :class:`~job_shop_lib.dispatching.FeatureObserver` or a string
+            or enum that represents a built-in feature observer.
+
+        graph_initializer:
+            Function to create the initial graph representation.
+            If ``None``, the default graph initializer is used:
+            :func:`~job_shop_lib.graphs.build_agent_task_graph`.
+        graph_updater_config:
+            Configuration for the graph updater. The graph updater is used
+            to update the graph representation after each action. If
+            ``None``, the default graph updater is used:
+            :class:`~job_shop_lib.graphs.ResidualGraphUpdater`.
+
+        ready_operations_filter:
+            Function to filter ready operations. If ``None``, the default
+            filter is used:
+            :func:`~job_shop_lib.dispatching.filter_dominated_operations`.
+
+        reward_function_config:
+            Configuration for the reward function. If ``None``, the default
+            reward function is used:
+            :class:`~job_shop_lib.dispatching.MakespanReward`.
+
+        render_mode:
+            Rendering mode for visualization. Supported modes are:
+
+            - human: Renders the current Gannt chart.
+            - save_video: Saves a video of the Gantt chart. Used only if
+                the schedule is completed.
+            - save_gif: Saves a GIF of the Gantt chart. Used only if the
+                schedule is completed.
+        render_config:
+            Configuration for rendering. See
+            :class:`~job_shop_lib.RenderConfig`.
+
+        use_padding:
+            Whether to use padding in observations. If True, all matrices
+            are padded to fixed sizes based on the maximum instance size.
+            Values are padded with -1, except for the "removed_nodes" key,
+            which is padded with ``True``, indicating that the node is
+            removed.
     """
 
     def __init__(
@@ -114,53 +174,6 @@ class MultiJobShopGraphEnv(gym.Env):
         render_config: RenderConfig | None = None,
         use_padding: bool = True,
     ) -> None:
-        """Initializes the environment.
-
-        Args:
-            instance_generator:
-                A :class:`~job_shop_lib.generation.InstanceGenerator` that
-                generates a new problem instance on each reset.
-            feature_observer_configs:
-                Configurations for feature observers. Each configuration
-                should be a
-                :class:`~job_shop_lib.dispatching.DispatcherObserverConfig`
-                with a class type that inherits from
-                :class:`~job_shop_lib.dispatching.FeatureObserver` or a string
-                or enum that represents a built-in feature observer.
-            graph_initializer:
-                Function to create the initial graph representation.
-                If ``None``, the default graph initializer is used:
-                :func:`~job_shop_lib.graphs.build_agent_task_graph`.
-            graph_updater_config:
-                Configuration for the graph updater. The graph updater is used
-                to update the graph representation after each action. If
-                ``None``, the default graph updater is used:
-                :class:`~job_shop_lib.graphs.ResidualGraphUpdater`.
-            ready_operations_filter:
-                Function to filter ready operations. If ``None``, the default
-                filter is used:
-                :func:`~job_shop_lib.dispatching.filter_dominated_operations`.
-            reward_function_config:
-                Configuration for the reward function. If ``None``, the default
-                reward function is used:
-                :class:`~job_shop_lib.dispatching.MakespanReward`.
-            render_mode:
-                Rendering mode for visualization. Supported modes are:
-                - human: Renders the current Gannt chart.
-                - save_video: Saves a video of the Gantt chart. Used only if
-                  the schedule is completed.
-                - save_gif: Saves a GIF of the Gantt chart. Used only if the
-                  schedule is completed.
-            render_config:
-                Configuration for rendering. See
-                :class:`~job_shop_lib.RenderConfig`.
-            use_padding:
-                Whether to use padding in observations. If True, all matrices
-                are padded to fixed sizes based on the maximum instance size.
-                Values are padded with -1, except for the "removed_nodes" key,
-                which is padded with ``True``, indicating that the node is
-                removed.
-        """
         super().__init__()
 
         # Create an instance with the maximum size
@@ -303,16 +316,15 @@ class MultiJobShopGraphEnv(gym.Env):
 
         Returns:
             A tuple containing the following elements:
+
             - The observation of the environment.
             - The reward obtained.
             - Whether the environment is done.
             - Whether the episode was truncated (always False).
             - A dictionary with additional information. The dictionary
-              contains the following keys:
-                - "feature_names": The names of the features in the
-                  observation.
-                - "available_operations": The operations that are ready to be
-                  scheduled.
+              contains the following keys: ``"feature_names"``, The names of
+              the features in the observation; ``"available_operations"``, the
+              operations that are ready to be scheduled.
         """
         obs, reward, done, truncated, info = (
             self.single_job_shop_graph_env.step(action)

job_shop_lib/reinforcement_learning/_single_job_shop_graph_env.py

@@ -45,6 +45,7 @@ class SingleJobShopGraphEnv(gym.Env):
 
     Observation Space:
         A dictionary with the following keys:
+
         - "removed_nodes": Binary vector indicating removed graph nodes.
         - "edge_list": Matrix of graph edges in COO format.
         - Feature matrices: Keys corresponding to the composite observer
@@ -54,43 +55,76 @@ class SingleJobShopGraphEnv(gym.Env):
         MultiDiscrete space representing (job_id, machine_id) pairs.
 
     Render Modes:
-        - "human": Displays the current Gantt chart.
-        - "save_video": Saves a video of the complete Gantt chart.
-        - "save_gif": Saves a GIF of the complete Gantt chart.
+
+    - "human": Displays the current Gantt chart.
+    - "save_video": Saves a video of the complete Gantt chart.
+    - "save_gif": Saves a GIF of the complete Gantt chart.
 
     Attributes:
         dispatcher:
             Manages the scheduling process. See
             :class:`~job_shop_lib.dispatching.Dispatcher`.
+
         composite_observer:
             A :class:`~job_shop_lib.dispatching.feature_observers.
             CompositeFeatureObserver` which aggregates features from multiple
             observers.
+
         graph_updater:
             Updates the graph representation after each action. See
             :class:`~job_shop_lib.graphs.GraphUpdater`.
+
         reward_function:
             Computes rewards for actions taken. See
             :class:`~job_shop_lib.reinforcement_learning.RewardObserver`.
+
         action_space:
             Defines the action space. The action is a tuple of two integers
             (job_id, machine_id). The machine_id can be -1 if the selected
             operation can only be scheduled in one machine.
+
         observation_space:
             Defines the observation space. The observation is a dictionary
             with the following keys:
+
             - "removed_nodes": Binary vector indicating removed graph nodes.
             - "edge_list": Matrix of graph edges in COO format.
             - Feature matrices: Keys corresponding to the composite observer
                 features (e.g., "operations", "jobs", "machines").
+
         render_mode:
             The mode for rendering the environment ("human", "save_video",
             "save_gif").
+
         gantt_chart_creator:
             Creates Gantt chart visualizations. See
             :class:`~job_shop_lib.visualization.GanttChartCreator`.
+
         use_padding:
             Whether to use padding in observations. Padding maintains the
+            observation space shape when the number of nodes changes.
+
+    Args:
+        job_shop_graph:
+            The JobShopGraph instance representing the job shop problem.
+        feature_observer_configs:
+            A list of FeatureObserverConfig instances for the feature
+            observers.
+        reward_function_config:
+            The configuration for the reward function.
+        graph_updater_config:
+            The configuration for the graph updater.
+        ready_operations_filter:
+            The function to use for pruning dominated operations.
+        render_mode:
+            The mode for rendering the environment ("human", "save_video",
+            "save_gif").
+        render_config:
+            Configuration for rendering (e.g., paths for saving videos
+            or GIFs). See :class:`~job_shop_lib.visualization.RenderConfig`.
+        use_padding:
+            Whether to use padding in observations. Padding maintains the
+            observation space shape when the number of nodes changes.
     """
 
     metadata = {"render_modes": ["human", "save_video", "save_gif"]}
@@ -116,29 +150,6 @@ class SingleJobShopGraphEnv(gym.Env):
         render_config: RenderConfig | None = None,
         use_padding: bool = True,
     ) -> None:
-        """Initializes the SingleJobShopGraphEnv environment.
-
-        Args:
-            job_shop_graph:
-                The JobShopGraph instance representing the job shop problem.
-            feature_observer_configs:
-                A list of FeatureObserverConfig instances for the feature
-                observers.
-            reward_function_config:
-                The configuration for the reward function.
-            graph_updater_config:
-                The configuration for the graph updater.
-            ready_operations_filter:
-                The function to use for pruning dominated operations.
-            render_mode:
-                The mode for rendering the environment ("human", "save_video",
-                "save_gif").
-            render_config:
-                Configuration for rendering (e.g., paths for saving videos
-                or GIFs).
-            use_padding:
-                Whether to use padding for the edge index.
-        """
         super().__init__()
         # Used for resetting the environment
         self.initial_job_shop_graph = deepcopy(job_shop_graph)
@@ -236,16 +247,16 @@ class SingleJobShopGraphEnv(gym.Env):
 
         Returns:
             A tuple containing the following elements:
+
             - The observation of the environment.
             - The reward obtained.
             - Whether the environment is done.
             - Whether the episode was truncated (always False).
             - A dictionary with additional information. The dictionary
-              contains the following keys:
-                - "feature_names": The names of the features in the
-                  observation.
-                - "available_operations": The operations that are ready to be
-                  scheduled.
+              contains the following keys: "feature_names", the names of the
+              features in the observation; "available_operations", the
+              operations that are ready to be scheduled.
+
         """
         job_id, machine_id = action
         operation = self.dispatcher.next_operation(job_id)
@@ -260,7 +271,7 @@ class SingleJobShopGraphEnv(gym.Env):
         truncated = False
         info: dict[str, Any] = {
             "feature_names": self.composite_observer.column_names,
-            "available_operations": self.dispatcher.ready_operations(),
+            "available_operations": self.dispatcher.available_operations(),
         }
         return obs, reward, done, truncated, info
 

job_shop_lib/reinforcement_learning/_types_and_constants.py

@@ -8,7 +8,7 @@ import numpy as np
 
 from job_shop_lib.dispatching.feature_observers import FeatureType
 from job_shop_lib.visualization import (
-    GanttChartWrapperConfig,
+    PartialGanttChartPlotterConfig,
     GifConfig,
     VideoConfig,
 )
@@ -17,7 +17,7 @@ from job_shop_lib.visualization import (
 class RenderConfig(TypedDict, total=False):
     """Configuration needed to initialize the `GanttChartCreator` class."""
 
-    gantt_chart_wrapper_config: GanttChartWrapperConfig
+    partial_gantt_chart_plotter_config: PartialGanttChartPlotterConfig
     video_config: VideoConfig
     gif_config: GifConfig
 

job_shop_lib/visualization/__init__.py

@@ -1,24 +1,41 @@
-"""Package for visualization."""
+"""Contains functions and classes for visualizing job shop scheduling problems.
 
-from job_shop_lib.visualization._gantt_chart import plot_gantt_chart
+.. autosummary::
+
+    plot_gantt_chart
+    get_partial_gantt_chart_plotter
+    PartialGanttChartPlotter
+    create_gantt_chart_video
+    create_gantt_chart_gif
+    plot_disjunctive_graph
+    plot_agent_task_graph
+    GanttChartCreator
+    GifConfig
+    VideoConfig
+
+"""
+
+from job_shop_lib.visualization._plot_gantt_chart import plot_gantt_chart
 from job_shop_lib.visualization._gantt_chart_video_and_gif_creation import (
-    create_gif,
+    create_gantt_chart_gif,
     create_gantt_chart_video,
     create_gantt_chart_frames,
-    plot_gantt_chart_wrapper,
+    get_partial_gantt_chart_plotter,
     create_video_from_frames,
     create_gif_from_frames,
+    PartialGanttChartPlotter,
 )
-from job_shop_lib.visualization._disjunctive_graph import (
+from job_shop_lib.visualization._plot_disjunctive_graph import (
     plot_disjunctive_graph,
+    duration_labeler,
 )
-from job_shop_lib.visualization._agent_task_graph import (
+from job_shop_lib.visualization._plot_agent_task_graph import (
     plot_agent_task_graph,
     three_columns_layout,
 )
 from job_shop_lib.visualization._gantt_chart_creator import (
     GanttChartCreator,
-    GanttChartWrapperConfig,
+    PartialGanttChartPlotterConfig,
     GifConfig,
     VideoConfig,
 )
@@ -26,16 +43,18 @@ from job_shop_lib.visualization._gantt_chart_creator import (
 __all__ = [
     "plot_gantt_chart",
     "create_gantt_chart_video",
-    "create_gif",
+    "create_gantt_chart_gif",
     "create_gantt_chart_frames",
-    "plot_gantt_chart_wrapper",
+    "get_partial_gantt_chart_plotter",
     "create_gif_from_frames",
     "create_video_from_frames",
     "plot_disjunctive_graph",
     "plot_agent_task_graph",
     "three_columns_layout",
     "GanttChartCreator",
-    "GanttChartWrapperConfig",
+    "PartialGanttChartPlotterConfig",
     "GifConfig",
     "VideoConfig",
+    "PartialGanttChartPlotter",
+    "duration_labeler",
 ]