job-shop-lib 1.1.1__py3-none-any.whl → 1.1.3__py3-none-any.whl

job_shop_lib/__init__.py

@@ -19,7 +19,7 @@ from job_shop_lib._schedule import Schedule
 from job_shop_lib._base_solver import BaseSolver, Solver
 
 
-__version__ = "1.1.1"
+__version__ = "1.1.3"
 
 __all__ = [
     "Operation",

job_shop_lib/_job_shop_instance.py

@@ -13,7 +13,7 @@ from job_shop_lib import Operation
 
 
 class JobShopInstance:
-    """Data structure to store a Job Shop Scheduling Problem instance.
+    r"""Data structure to store a Job Shop Scheduling Problem instance.
 
     Additional attributes such as ``num_machines`` or ``durations_matrix`` can
     be computed from the instance and are cached for performance since they
@@ -75,7 +75,7 @@ class JobShopInstance:
             attributes of the operations are set when the instance is created.
             See :meth:`set_operation_attributes` for more information. Defaults
             to True.
-        **metadata:
+        \**metadata:
             Additional information about the instance.
     """
 
@@ -131,7 +131,7 @@ class JobShopInstance:
         name: str | None = None,
         **metadata: Any,
     ) -> JobShopInstance:
-        """Creates a JobShopInstance from a file following Taillard's format.
+        r"""Creates a JobShopInstance from a file following Taillard's format.
 
         Args:
             file_path:
@@ -144,7 +144,7 @@ class JobShopInstance:
             name:
                 A string with the name of the instance. If not provided, the
                 name of the instance is set to the name of the file.
-            **metadata:
+            \**metadata:
                 Additional information about the instance.
 
         Returns:
@@ -221,7 +221,7 @@ class JobShopInstance:
                 A list of lists of integers. The i-th list contains the
                 durations of the operations of the job with id i.
             machines_matrix:
-            A list of lists of lists of integers if the
+                A list of lists of lists of integers if the
                 instance is flexible, or a list of lists of integers if the
                 instance is not flexible. The i-th list contains the machines
                 in which the operations of the job with id i can be processed.

job_shop_lib/_schedule.py

@@ -10,7 +10,7 @@ from job_shop_lib.exceptions import ValidationError
 
 
 class Schedule:
-    """Data structure to store a complete or partial solution for a particular
+    r"""Data structure to store a complete or partial solution for a particular
     :class:`JobShopInstance`.
 
     A schedule is a list of lists of :class:`ScheduledOperation` objects. Each
@@ -33,7 +33,7 @@ class Schedule:
             A list of lists of :class:`ScheduledOperation` objects. Each
             list represents the order of operations on a machine. If
             not provided, the schedule is initialized as an empty schedule.
-        **metadata:
+        \**metadata:
             Additional information about the schedule.
     """
 

job_shop_lib/dispatching/_dispatcher.py

@@ -30,9 +30,12 @@ def no_setup_time_calculator(
     operation belongs.
 
     Args:
-        dispatcher: The dispatcher instance.
-        operation: The operation to be scheduled.
-        machine_id: The id of the machine on which the operation is to be
+        dispatcher:
+            The dispatcher instance.
+        operation:
+            The operation to be scheduled.
+        machine_id:
+            The id of the machine on which the operation is to be
             scheduled.
 
     Returns:
@@ -329,8 +332,10 @@ class Dispatcher:
                 :attr:`~job_shop_lib.Operation.machine_id` attribute is used.
 
         Raises:
-            ValidationError: If the operation is not ready to be scheduled.
-            UninitializedAttributeError: If the operation has multiple
+            ValidationError:
+                If the operation is not ready to be scheduled.
+            UninitializedAttributeError:
+                If the operation has multiple
                 machines in its list and no ``machine_id`` is provided.
         """
 
@@ -408,7 +413,7 @@ class Dispatcher:
         condition: Callable[[DispatcherObserver], bool] = lambda _: True,
         **kwargs,
     ) -> ObserverType:
-        """Creates a new observer of the specified type or returns an existing
+        r"""Creates a new observer of the specified type or returns an existing
         observer of the same type if it already exists in the dispatcher's list
         of observers.
 
@@ -419,7 +424,7 @@ class Dispatcher:
                 A function that takes an observer and returns True if it is
                 the observer to be retrieved. By default, it returns True for
                 all observers.
-            **kwargs:
+            \**kwargs:
                 Additional keyword arguments to be passed to the observer's
                 constructor.
         """

job_shop_lib/dispatching/_optimal_operations_observer.py

@@ -21,10 +21,13 @@ class OptimalOperationsObserver(DispatcherObserver):
             operations.
 
     Args:
-        dispatcher: The dispatcher instance to observe.
-        reference_schedule: A complete schedule that represents the optimal
+        dispatcher:
+            The dispatcher instance to observe.
+        reference_schedule:
+            A complete schedule that represents the optimal
             or reference solution.
-        subscribe: If True, automatically subscribes to the dispatcher.
+        subscribe:
+            If True, automatically subscribes to the dispatcher.
 
     Raises:
         ValidationError: If the reference schedule is incomplete or if it

job_shop_lib/dispatching/feature_observers/_composite_feature_observer.py

@@ -11,7 +11,6 @@ import numpy as np
 from numpy.typing import NDArray
 import pandas as pd
 
-from job_shop_lib.exceptions import ValidationError
 from job_shop_lib.dispatching import Dispatcher
 from job_shop_lib.dispatching.feature_observers import (
     FeatureObserver,
@@ -86,19 +85,11 @@ class CompositeFeatureObserver(FeatureObserver):
                 for observer in dispatcher.subscribers
                 if isinstance(observer, FeatureObserver)
             ]
-        feature_types = self._get_feature_types_list(feature_types)
-        for observer in feature_observers:
-            if not set(observer.features.keys()).issubset(set(feature_types)):
-                raise ValidationError(
-                    "The feature types observed by the feature observer "
-                    f"{observer.__class__.__name__} are not a subset of the "
-                    "feature types specified in the CompositeFeatureObserver."
-                    f"Observer feature types: {observer.features.keys()}"
-                    f"Composite feature types: {feature_types}"
-                )
         self.feature_observers = feature_observers
         self.column_names: dict[FeatureType, list[str]] = defaultdict(list)
-        super().__init__(dispatcher, subscribe=subscribe)
+        super().__init__(
+            dispatcher, subscribe=subscribe, feature_types=feature_types
+        )
         self._set_column_names()
 
     @classmethod
@@ -148,12 +139,17 @@ class CompositeFeatureObserver(FeatureObserver):
             list
         )
         for observer in self.feature_observers:
-            for feature_type, feature_matrix in observer.features.items():
+            for feature_type in self.supported_feature_types:
+                feature_matrix = observer.features.get(feature_type)
+                if feature_matrix is None:
+                    continue
                 features[feature_type].append(feature_matrix)
 
         self.features = {
-            feature_type: np.concatenate(features, axis=1)
-            for feature_type, features in features.items()
+            feature_type: np.concatenate(
+                feature_matrices, axis=1  # type: ignore[misc]
+            )
+            for feature_type, feature_matrices in features.items()
         }
 
     def _set_column_names(self):
@@ -177,34 +173,3 @@ class CompositeFeatureObserver(FeatureObserver):
             out.append(f"{feature_type.value}:")
             out.append(dataframe.to_string())
         return "\n".join(out)
-
-
-if __name__ == "__main__":
-    # from cProfile import Profile
-    import time
-    from job_shop_lib.benchmarking import load_benchmark_instance
-    from job_shop_lib.dispatching.rules import DispatchingRuleSolver
-
-    ta80 = load_benchmark_instance("ta80")
-
-    dispatcher_ = Dispatcher(ta80)
-    feature_observer_types_ = list(FeatureObserverType)
-    feature_observers_ = [
-        feature_observer_factory(
-            observer_type,
-            dispatcher=dispatcher_,
-        )
-        for observer_type in feature_observer_types_
-        # and not FeatureObserverType.EARLIEST_START_TIME
-    ]
-    composite_observer_ = CompositeFeatureObserver(
-        dispatcher_, feature_observers=feature_observers_
-    )
-    solver = DispatchingRuleSolver(dispatching_rule="random")
-    # profiler = Profile()
-    # profiler.runcall(solver.solve, dispatcher_.instance, dispatcher_)
-    # profiler.print_stats("cumtime")
-    start = time.perf_counter()
-    solver.solve(dispatcher_.instance, dispatcher_)
-    end = time.perf_counter()
-    print(f"Time: {end - start}")

job_shop_lib/dispatching/feature_observers/_earliest_start_time_observer.py

@@ -93,8 +93,8 @@ class EarliestStartTimeObserver(FeatureObserver):
         # Cache:
         operations_by_machine = dispatcher.instance.operations_by_machine
         self._is_regular_instance = all(
-            len(job) == len(dispatcher.instance.jobs[0])
-            for job in dispatcher.instance.jobs
+            len(machine_ops) == len(operations_by_machine[0])
+            for machine_ops in operations_by_machine
         )
         if self._is_regular_instance:
             self._job_ids = np.array(

job_shop_lib/dispatching/feature_observers/_factory.py

@@ -1,5 +1,3 @@
-"""Contains factory functions for creating :class:`FeatureObserver`s."""
-
 from enum import Enum
 
 from job_shop_lib.dispatching import DispatcherObserverConfig
@@ -57,13 +55,13 @@ def feature_observer_factory(
     ),
     **kwargs,
 ) -> FeatureObserver:
-    """Creates and returns a :class:`FeatureObserver` based on the specified
+    r"""Creates and returns a :class:`FeatureObserver` based on the specified
     :class:`FeatureObserver` type.
 
     Args:
         feature_creator_type:
             The type of :class:`FeatureObserver` to create.
-        **kwargs:
+        \*\*kwargs:
             Additional keyword arguments to pass to the
             :class:`FeatureObserver` constructor.
 

job_shop_lib/dispatching/feature_observers/_feature_observer.py

@@ -92,6 +92,9 @@ class FeatureObserver(DispatcherObserver):
                 feature_type: self._feature_sizes
                 for feature_type in feature_types
             }
+        else:
+            feature_size = self._feature_sizes
+
         super().__init__(dispatcher, subscribe=subscribe)
 
         number_of_entities = {

job_shop_lib/dispatching/rules/_dispatching_rule_solver.py

@@ -148,49 +148,3 @@ class DispatchingRuleSolver(BaseSolver):
         selected_operation = self.dispatching_rule(dispatcher)
         machine_id = self.machine_chooser(dispatcher, selected_operation)
         dispatcher.dispatch(selected_operation, machine_id)
-
-
-if __name__ == "__main__":
-    import time
-    import cProfile
-
-    # import pstats
-    # from io import StringIO
-    from job_shop_lib.benchmarking import (
-        # load_benchmark_instance,
-        load_all_benchmark_instances,
-    )
-
-    # from job_shop_lib.dispatching.rules._dispatching_rules_functions import (
-    #     most_work_remaining_rule_2,
-    # )
-
-    # ta_instances = [
-    #     load_benchmark_instance(f"ta{i:02d}") for i in range(1, 81)
-    # ]
-    ta_instances = load_all_benchmark_instances().values()
-    solver = DispatchingRuleSolver(
-        dispatching_rule="most_work_remaining", ready_operations_filter=None
-    )
-
-    start = time.perf_counter()
-
-    # Create a Profile object
-    profiler = cProfile.Profile()
-
-    # Run the code under profiling
-    # profiler.enable()
-    for instance_ in ta_instances:
-        solver.solve(instance_)
-    # profiler.disable()
-
-    end = time.perf_counter()
-
-    # Print elapsed time
-    print(f"Elapsed time: {end - start:.2f} seconds.")
-
-    # Print profiling results
-    # s = StringIO()
-    # ps = pstats.Stats(profiler, stream=s).sort_stats("cumulative")
-    # profiler.print_stats("cumtime")  # Print top 20 time-consuming functions
-    # print(s.getvalue())

job_shop_lib/dispatching/rules/_dispatching_rules_functions.py

@@ -35,7 +35,23 @@ def first_come_first_served_rule(dispatcher: Dispatcher) -> Operation:
 
 
 def most_work_remaining_rule(dispatcher: Dispatcher) -> Operation:
-    """Dispatches the operation which job has the most remaining work."""
+    """Dispatches the operation which job has the most remaining work.
+
+    The remaining work of a job is defined as the sum of the durations of
+    all unscheduled operations in that job. The operation with the highest
+    remaining work is selected for dispatching. Note that uncompleted
+    but scheduled operations are not considered in this rule, only
+    unscheduled operations are taken into account.
+
+    Args:
+        dispatcher:
+            The :class:`~job_shop_lib.dispatching.Dispatcher` instance
+            containing the job shop instance and the current state of the
+            schedule.
+
+    Returns:
+        The operation that belongs to the job with the most remaining work.
+    """
     job_remaining_work = [0] * dispatcher.instance.num_jobs
     for operation in dispatcher.unscheduled_operations():
         job_remaining_work[operation.job_id] += operation.duration
@@ -47,7 +63,23 @@ def most_work_remaining_rule(dispatcher: Dispatcher) -> Operation:
 
 
 def most_operations_remaining_rule(dispatcher: Dispatcher) -> Operation:
-    """Dispatches the operation which job has the most remaining operations."""
+    """Dispatches the operation which job has the most remaining operations.
+
+    The remaining operations of a job are defined as the number of
+    uncompleted operations in that job. The operation with the highest
+    number of remaining operations is selected for dispatching. Note that
+    uncompleted but scheduled operations are considered in this rule.
+
+    Args:
+        dispatcher:
+            The :class:`~job_shop_lib.dispatching.Dispatcher` instance
+            containing the job shop instance and the current state of the
+            schedule.
+
+    Returns:
+        The operation that belongs to the job with the most remaining
+        operations.
+    """
     job_remaining_operations = [0] * dispatcher.instance.num_jobs
     for operation in dispatcher.uncompleted_operations():
         job_remaining_operations[operation.job_id] += 1
@@ -69,7 +101,9 @@ def score_based_rule(
     """Creates a dispatching rule based on a scoring function.
 
     Args:
-        score_function: A function that takes a Dispatcher instance as input
+        score_function:
+            A function that takes a
+            :class:`~job_shop_lib.dispatching.Dispatcher` instance as input
             and returns a list of scores for each job.
 
     Returns:
@@ -97,7 +131,9 @@ def score_based_rule_with_tie_breaker(
     still a tie, the third scoring function is used, and so on.
 
     Args:
-        score_functions: A list of scoring functions that take a Dispatcher
+        score_functions
+            A list of scoring functions that take a
+            :class:`~job_shop_lib.dispatching.Dispatcher`
             instance as input and return a list of scores for each job.
     """
 
@@ -123,7 +159,21 @@ def score_based_rule_with_tie_breaker(
 
 
 def shortest_processing_time_score(dispatcher: Dispatcher) -> list[int]:
-    """Scores each job based on the duration of the next operation."""
+    """Scores each job based on the duration of the next operation.
+
+    The score is the negative duration of the next operation in each job.
+    This means that jobs with shorter next operations will have higher scores.
+
+    Args:
+        dispatcher:
+            The :class:`~job_shop_lib.dispatching.Dispatcher` instance
+            containing the job shop instance and the current state of the
+            schedule.
+
+    Returns:
+        A list of scores for each job, where the score is the negative
+        duration of the next operation in that job.
+    """
     num_jobs = dispatcher.instance.num_jobs
     scores = [0] * num_jobs
     for operation in dispatcher.available_operations():
@@ -132,11 +182,26 @@ def shortest_processing_time_score(dispatcher: Dispatcher) -> list[int]:
 
 
 def first_come_first_served_score(dispatcher: Dispatcher) -> list[int]:
-    """Scores each job based on the position of the next operation."""
+    """Scores each job based on the position of the next operation.
+
+    The score is the negative position of the next operation in each job.
+    This means that jobs with operations that are earlier in the job will have
+    higher scores.
+
+    Args:
+        dispatcher:
+            The :class:`~job_shop_lib.dispatching.Dispatcher` instance
+            containing the job shop instance and the current state of the
+            schedule.
+
+    Returns:
+        A list of scores for each job, where the score is the negative
+        position of the next operation in that job.
+    """
     num_jobs = dispatcher.instance.num_jobs
     scores = [0] * num_jobs
     for operation in dispatcher.available_operations():
-        scores[operation.job_id] = operation.operation_id
+        scores[operation.job_id] = -operation.operation_id
     return scores
 
 
@@ -145,8 +210,8 @@ class MostWorkRemainingScorer:  # pylint: disable=too-few-public-methods
 
     This class is conceptually a function: it can be called with a
     :class:`~job_shop_lib.dispatching.Dispatcher` instance as input, and it
-    returns a list of scores for each job. The reason for using a class instead
-    of a function is to cache the observers that are created for each
+    returns a list of scores for each job. The reason for using a class
+    instead of a function is to cache the observers that are created for each
     dispatcher instance. This way, the observers do not have to be retrieved
     every time the function is called.
 
@@ -195,10 +260,26 @@ class MostWorkRemainingScorer:  # pylint: disable=too-few-public-methods
 observer_based_most_work_remaining_rule = score_based_rule(
     MostWorkRemainingScorer()
 )
+"""Dispatching rule that uses the :class:`MostWorkRemainingScorer` to select
+the next operation."""
 
 
 def most_operations_remaining_score(dispatcher: Dispatcher) -> list[int]:
-    """Scores each job based on the remaining operations in the job."""
+    """Scores each job based on the remaining operations in the job.
+
+    The score is the number of uncompleted operations in each job. This means
+    that jobs with more uncompleted operations will have higher scores.
+
+    Args:
+        dispatcher:
+            The :class:`~job_shop_lib.dispatching.Dispatcher` instance
+            containing the job shop instance and the current state of the
+            schedule.
+
+    Returns:
+        A list of scores for each job, where the score is the number of
+        uncompleted operations in that job.
+    """
     num_jobs = dispatcher.instance.num_jobs
     scores = [0] * num_jobs
     for operation in dispatcher.uncompleted_operations():
@@ -207,7 +288,21 @@ def most_operations_remaining_score(dispatcher: Dispatcher) -> list[int]:
 
 
 def random_score(dispatcher: Dispatcher) -> list[int]:
-    """Scores each job randomly."""
+    """Scores each job randomly.
+
+    This function generates a random score for each job in the job shop
+    instance. The scores are integers between 0 and 100, inclusive.
+
+    Args:
+        dispatcher:
+            The :class:`~job_shop_lib.dispatching.Dispatcher` instance
+            containing the job shop instance and the current state of the
+            schedule.
+
+    Returns:
+        A list of random scores for each job, where each score is an integer
+        between 0 and 100.
+    """
     return [
         random.randint(0, 100) for _ in range(dispatcher.instance.num_jobs)
     ]

job_shop_lib/generation/_general_instance_generator.py

@@ -129,16 +129,18 @@ class GeneralInstanceGenerator(InstanceGenerator):
         num_machines: int | None = None,
     ) -> JobShopInstance:
         if num_jobs is None:
-            num_jobs = self.rng.integers(
-                self.num_jobs_range[0], self.num_jobs_range[1] + 1
+            num_jobs = int(
+                self.rng.integers(
+                    self.num_jobs_range[0], self.num_jobs_range[1] + 1
+                )
             )
 
         if num_machines is None:
             min_num_machines, max_num_machines = self.num_machines_range
             if not self.allow_less_jobs_than_machines:
                 min_num_machines = min(num_jobs, max_num_machines)
-            num_machines = self.rng.integers(
-                min_num_machines, max_num_machines + 1
+            num_machines = int(
+                self.rng.integers(min_num_machines, max_num_machines + 1)
             )
         elif (
             not self.allow_less_jobs_than_machines and num_jobs < num_machines

job_shop_lib/graphs/_build_resource_task_graphs.py

@@ -9,6 +9,7 @@ connected with machine ones. All machine nodes are connected between them, and
 all operation nodes from the same job are connected by non-directed edges too.
 
 References:
+
 - Junyoung Park, Sanjar Bakhtiyar, and Jinkyoo Park. Schedulenet: Learn to
   solve multi-agent scheduling problems with reinforcement learning. ArXiv,
   abs/2106.03051, 2021.

job_shop_lib/graphs/_job_shop_graph.py

@@ -166,7 +166,7 @@ class JobShopGraph:
         v_of_edge: Node | int,
         **attr,
     ) -> None:
-        """Adds an edge to the graph.
+        r"""Adds an edge to the graph.
 
         It automatically determines the edge type based on the source and
         destination nodes unless explicitly provided in the ``attr`` argument
@@ -182,7 +182,7 @@ class JobShopGraph:
                 The destination node of the edge. If it is a :class:`Node`,
                 its ``node_id`` is used as the destination. Otherwise, it
                 is assumed to be the ``node_id`` of the destination.
-            **attr:
+            \**attr:
                 Additional attributes to be added to the edge.
 
         Raises:

job_shop_lib/reinforcement_learning/_multi_job_shop_graph_env.py

@@ -277,7 +277,8 @@ class MultiJobShopGraphEnv(gym.Env):
             options: Additional options for reset (currently unused).
 
         Returns:
-            A tuple containing:
+            tuple[ObservationDict, dict[str, Any]]:
+
             - ObservationDict: The initial observation of the environment.
             - dict: An info dictionary containing additional information about
               the reset state. This may include details about the generated
@@ -305,7 +306,7 @@ class MultiJobShopGraphEnv(gym.Env):
     def step(
         self, action: tuple[int, int]
     ) -> tuple[ObservationDict, float, bool, bool, dict[str, Any]]:
-        """Takes a step in the environment.
+        r"""Takes a step in the environment.
 
         Args:
             action:
@@ -315,7 +316,7 @@ class MultiJobShopGraphEnv(gym.Env):
                 operation.
 
         Returns:
-            A tuple containing the following elements:
+            tuple[ObservationDict, float, bool, bool, dict[str, Any]]:
 
             - The observation of the environment.
             - The reward obtained.

job_shop_lib/reinforcement_learning/_resource_task_graph_observation.py

@@ -247,9 +247,11 @@ class ResourceTaskGraphObservation(ObservationWrapper, Generic[EnvType]):
     def _get_start_from_zero_mappings(
         original_indices_dict: dict[str, NDArray[np.int32]],
     ) -> dict[str, dict[int, int]]:
-        mappings = {}
+        mappings: dict[str, dict[int, int]] = {}
         for key, indices in original_indices_dict.items():
-            mappings[key] = {idx: i for i, idx in enumerate(indices)}
+            mappings[key] = {
+                idx: i for i, idx in enumerate(indices)  # type: ignore[misc]
+            }  # idx is an integer (false positive)
         return mappings
 
     def _create_node_features_dict(
@@ -318,7 +320,7 @@ class ResourceTaskGraphObservation(ObservationWrapper, Generic[EnvType]):
                 ~removed_nodes_of_this_type
             ]
             original_ids_dict[node_type] = np.where(
-                ~removed_nodes_of_this_type
+                ~removed_nodes_of_this_type  # type: ignore[assignment]
             )[0]
 
         return removed_nodes_dict, original_ids_dict

job_shop_lib/reinforcement_learning/_single_job_shop_graph_env.py

@@ -3,10 +3,12 @@
 from copy import deepcopy
 from collections.abc import Callable, Sequence
 from typing import Any
+import warnings
 
 import matplotlib.pyplot as plt
 import gymnasium as gym
 import numpy as np
+
 from numpy.typing import NDArray
 
 from job_shop_lib import JobShopInstance, Operation
@@ -207,17 +209,34 @@ class SingleJobShopGraphEnv(gym.Env):
         """Returns current makespan of partial schedule."""
         return self.dispatcher.schedule.makespan()
 
-    def machine_utilization(self) -> NDArray[np.float32]:
-        """Returns utilization percentage for each machine."""
+    def machine_utilization(  # noqa: DOC201,DOC203
+        self,
+    ) -> NDArray[np.float32]:
+        """Returns utilization percentage for each machine.
+
+        Returns:
+            Utilization percentage for each machine as a numpy array.
+
+        .. deprecated:: 1.1.2
+            This method is deprecated and will be removed in version 2.0.0.
+        """
+        warnings.warn(
+            "machine_utilization is deprecated and will be removed in "
+            "version 2.0.0",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         total_time = max(1, self.current_makespan())  # Avoid division by zero
-        machine_busy_time = np.zeros(self.instance.num_machines)
+        machine_busy_time = np.zeros(
+            self.instance.num_machines, dtype=np.float32
+        )
 
         for m_id, m_schedule in enumerate(self.dispatcher.schedule.schedule):
             machine_busy_time[m_id] = sum(
                 op.operation.duration for op in m_schedule
             )
 
-        return machine_busy_time / total_time
+        return machine_busy_time / total_time  # type: ignore[return-value]
 
     def _get_observation_space(self) -> gym.spaces.Dict:
         """Returns the observation space dictionary."""
@@ -414,28 +433,3 @@ class SingleJobShopGraphEnv(gym.Env):
             raise ValidationError(
                 f"Operation {next_operation} requires a machine_id"
             )
-
-
-if __name__ == "__main__":
-    from job_shop_lib.dispatching.feature_observers import (
-        FeatureObserverType,
-        FeatureType,
-    )
-    from job_shop_lib.graphs import build_disjunctive_graph
-    from job_shop_lib.benchmarking import load_benchmark_instance
-
-    instance = load_benchmark_instance("ft06")
-    job_shop_graph_ = build_disjunctive_graph(instance)
-    feature_observer_configs_: list[DispatcherObserverConfig] = [
-        DispatcherObserverConfig(
-            FeatureObserverType.IS_READY,
-            kwargs={"feature_types": [FeatureType.JOBS]},
-        )
-    ]
-
-    env = SingleJobShopGraphEnv(
-        job_shop_graph=job_shop_graph_,
-        feature_observer_configs=feature_observer_configs_,
-        render_mode="save_video",
-        render_config={"video_config": {"fps": 4}},
-    )

job_shop_lib/visualization/gantt/_gantt_chart_video_and_gif_creation.py

@@ -70,14 +70,16 @@ def get_partial_gantt_chart_plotter(
     show_available_operations: bool = False,
     **kwargs: Any,
 ) -> PartialGanttChartPlotter:
-    """Returns a function that plots a Gantt chart for an unfinished schedule.
+    r"""Returns a function that plots a Gantt chart for an unfinished schedule.
 
     Args:
-        title: The title of the Gantt chart.
-        cmap: The name of the colormap to use.
+        title:
+            The title of the Gantt chart.
+        cmap:
+            The name of the colormap to use.
         show_available_operations:
             Whether to show the available operations in the Gantt chart.
-        **kwargs: Additional keyword arguments to pass to the
+        \*\*kwargs: Additional keyword arguments to pass to the
             :func:`plot_gantt_chart` function.
 
     Returns:

job_shop_lib/visualization/graphs/_plot_disjunctive_graph.py

@@ -366,18 +366,25 @@ def plot_disjunctive_graph(
 
     # Add machine colors to the legend
     if show_machine_colors_in_legend:
+        label_color_pairs = []
+        sorted_machine_colors = sorted(
+            machine_colors.items(), key=lambda x: x[0]
+        )
+        for machine_id, color in sorted_machine_colors:
+            label = None
+            if machine_id == -1:
+                continue
+            if machine_labels is not None:
+                label = machine_labels[machine_id]
+            elif machine_id >= 0:
+                label = f"Machine {machine_id}"
+
+            if label:  # Add patch if a label was determined
+                label_color_pairs.append((label, color))
+
         machine_patches = [
-            matplotlib.patches.Patch(
-                color=color,
-                label=(
-                    machine_labels[machine_id]
-                    if machine_labels is not None
-                    else f"Machine {machine_id}"
-                ),
-            )
-            for machine_id, color in sorted(
-                machine_colors.items(), key=lambda x: x[0]
-            )
+            matplotlib.patches.Patch(color=color, label=label)
+            for label, color in sorted(label_color_pairs)
         ]
         handles.extend(machine_patches)
 

job_shop_lib/visualization/graphs/_plot_resource_task_graph.py

@@ -86,7 +86,7 @@ def plot_resource_task_graph(
     """
     if title is None:
         title = (
-            "Heterogeneous Graph Visualization:"
+            "Heterogeneous Graph Visualization: "
             f"{job_shop_graph.instance.name}"
         )
     # Create a new figure and axis

{job_shop_lib-1.1.1.dist-info → job_shop_lib-1.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 1.1.1
+Version: 1.1.3
 Summary: An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)
 License: MIT
 Author: Pabloo22
@@ -17,7 +17,8 @@ Requires-Dist: imageio[ffmpeg] (>=2.34.1,<3.0.0)
 Requires-Dist: matplotlib (>=3,<4)
 Requires-Dist: networkx (>=3,<4)
 Requires-Dist: numpy (>=1.26.4,<3.0.0)
-Requires-Dist: ortools (>=9.9,<10.0)
+Requires-Dist: ortools (>=9.9,<10.0) ; sys_platform != "darwin"
+Requires-Dist: ortools (>=9.9,<9.13) ; sys_platform == "darwin"
 Requires-Dist: pyarrow (>=15,<21)
 Requires-Dist: pygraphviz (>=1.12,<2.0) ; extra == "pygraphviz"
 Description-Content-Type: text/markdown
@@ -30,6 +31,7 @@ Description-Content-Type: text/markdown
 
 [![Tests](https://github.com/Pabloo22/job_shop_lib/actions/workflows/tests.yaml/badge.svg)](https://github.com/Pabloo22/job_shop_lib/actions/workflows/tests.yaml)
 [![Documentation Status](https://readthedocs.org/projects/job-shop-lib/badge/?version=latest)](https://job-shop-lib.readthedocs.io/en/latest/?badge=latest)
+[![codecov](https://codecov.io/gh/Pabloo22/job_shop_lib/graph/badge.svg?token=DWXLYJWAOZ)](https://codecov.io/gh/Pabloo22/job_shop_lib)
 ![Python versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
 [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -84,6 +86,24 @@ pip install job-shop-lib
 
 <!-- end key features -->
 
+## Publication :scroll:
+
+For an in-depth explanation of the library (v1.0.0), including its design, features, reinforcement learning environments, and some experiments, please refer to my [Bachelor's thesis](https://www.arxiv.org/abs/2506.13781).
+
+You can also cite the library using the following BibTeX entry:
+
+```bibtex
+@misc{arino2025jobshoplib,
+      title={Solving the Job Shop Scheduling Problem with Graph Neural Networks: A Customizable Reinforcement Learning Environment}, 
+      author={Pablo Ariño Fernández},
+      year={2025},
+      eprint={2506.13781},
+      archivePrefix={arXiv},
+      primaryClass={cs.LG},
+      url={https://arxiv.org/abs/2506.13781}, 
+}
+```
+
 ## Some Examples :rocket:
 
 ### Create a Job Shop Instance
@@ -328,31 +348,82 @@ plt.show()
 
 The library generalizes this graph by allowing the addition of job nodes and a global one (see `build_resource_task_graph_with_jobs` and `build_resource_task_graph`).
 
-For more details, check the [examples](examples) folder.
+### Gymnasium Environments
 
-## Installation for development
+<div align="center">
+<img src="docs/source/images/rl_diagram.png">
+</div>
+<br>
 
-<!-- start installation development -->
 
-1. Clone the repository.
+The `SingleJobShopGraphEnv` allows to learn from a single job shop instance, while the `MultiJobShopGraphEnv` generates a new instance at each reset. For an in-depth explanation of the environments see chapter 7 of my [Bachelor's thesis](https://www.arxiv.org/abs/2506.13781).
 
-```bash
-git clone https://github.com/Pabloo22/job_shop_lib.git
-cd job_shop_lib
-```
+```python
+from IPython.display import clear_output
+
+from job_shop_lib.reinforcement_learning import (
+    # MakespanReward,
+    SingleJobShopGraphEnv,
+    ObservationSpaceKey,
+    IdleTimeReward,
+    ObservationDict,
+)
+from job_shop_lib.dispatching.feature_observers import (
+    FeatureObserverType,
+    FeatureType,
+)
+from job_shop_lib.dispatching import DispatcherObserverConfig
+
+
+instance = load_benchmark_instance("ft06")
+job_shop_graph = build_disjunctive_graph(instance)
+feature_observer_configs = [
+    DispatcherObserverConfig(
+        FeatureObserverType.IS_READY,
+        kwargs={"feature_types": [FeatureType.JOBS]},
+    )
+]
+
+env = SingleJobShopGraphEnv(
+    job_shop_graph=job_shop_graph,
+    feature_observer_configs=feature_observer_configs,
+    reward_function_config=DispatcherObserverConfig(IdleTimeReward),
+    render_mode="human",  # Try "save_video"
+    render_config={
+        "video_config": {"fps": 4}
+    }
+)
 
-2. Install [poetry](https://python-poetry.org/docs/) if you don't have it already:
 
-```bash
-pip install poetry
-```
+def random_action(observation: ObservationDict) -> tuple[int, int]:
+    ready_jobs = []
+    for job_id, is_ready in enumerate(
+        observation[ObservationSpaceKey.JOBS.value].ravel()
+    ):
+        if is_ready == 1.0:
+            ready_jobs.append(job_id)
 
-3. Install dependencies:
-```bash
-make poetry_install_all 
+    job_id = random.choice(ready_jobs)
+    machine_id = -1  # We can use -1 if each operation can only be scheduled
+    # on one machine.
+    return (job_id, machine_id)
+
+
+done = False
+obs, _ = env.reset()
+while not done:
+    action = random_action(obs)
+    obs, reward, done, *_ = env.step(action)
+    if env.render_mode == "human":
+        env.render()
+        clear_output(wait=True)
+
+if env.render_mode == "save_video" or env.render_mode == "save_gif":
+    env.render()
 ```
 
-<!-- end installation development -->
+## Contributing :handshake:
+Any contribution is welcome, whether it's a small bug or documentation fix or a new feature! See the [CONTRIBUTING.md](CONTRIBUTING.md) file for details on how to contribute to this project.
 
 ## License :scroll:
 
@@ -389,5 +460,5 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
  - E. Taillard, "Benchmarks for basic scheduling problems," European
      Journal of Operational Research, vol. 64, no. 2, pp. 278–285, 1993.
 
-- Park, Junyoung, Sanjar Bakhtiyar, and Jinkyoo Park. "ScheduleNet: Learn to solve multi-agent scheduling problems with reinforcement learning." arXiv preprint arXiv:2106.03051, 2021. 
+  - Park, Junyoung, Sanjar Bakhtiyar, and Jinkyoo Park. "ScheduleNet: Learn to solve multi-agent scheduling problems with reinforcement learning." arXiv preprint arXiv:2106.03051, 2021. 
 

{job_shop_lib-1.1.1.dist-info → job_shop_lib-1.1.3.dist-info}/RECORD

@@ -1,8 +1,8 @@
-job_shop_lib/__init__.py,sha256=DaQp6Dk3OL1ctejjmmmv7bkK3M6_4D09Q_OB8bF_AuI,639
+job_shop_lib/__init__.py,sha256=y-1uRgW-6xUddIIj3ksBlqxbSMJZkLZCSqBELQhL5mw,639
 job_shop_lib/_base_solver.py,sha256=p17XmtufNc9Y481cqZUT45pEkUmmW1HWG53dfhIBJH8,1363
-job_shop_lib/_job_shop_instance.py,sha256=RWibh5_lVTHj0DEkMw94O4jYZhwRReYYpVVIbT0cYtQ,18353
+job_shop_lib/_job_shop_instance.py,sha256=FkMBy9Yb8cNEGswI9vlN3Wh4mhtEX-QuDbKvSYUOXcM,18361
 job_shop_lib/_operation.py,sha256=lwCjgXwWlgESFuV3Yh4SCVofPGCd3hJU4vnK7peREac,4235
-job_shop_lib/_schedule.py,sha256=pY02c-VF7cHxR29dFAktrn32mFi0cmRIcDAGsoekK8g,11941
+job_shop_lib/_schedule.py,sha256=PX3wOv9Cw8NgjBLV3yDJW0mNl7a25nvoEV5Hdv7R_-g,11943
 job_shop_lib/_scheduled_operation.py,sha256=czrGr87EOTlO2NPolIN5CDigeiCzvQEyra5IZPwSFZc,2801
 job_shop_lib/benchmarking/__init__.py,sha256=JPnCw5mK7sADAW0HctVKHEDRw22afp9caNh2eUS36Ys,3290
 job_shop_lib/benchmarking/_load_benchmark.py,sha256=-cgyx0Kn6uAc3KdGFSQb6eUVQjQggmpVKOH9qusNkXI,2930
@@ -10,20 +10,20 @@ job_shop_lib/benchmarking/benchmark_instances.json,sha256=F9EvyzFwVxiKAN6rQTsrMh
 job_shop_lib/constraint_programming/__init__.py,sha256=kKQRUxxS_nVFUdXGnf4bQOD9mqrXxZZWElS753A4YiA,454
 job_shop_lib/constraint_programming/_ortools_solver.py,sha256=oMPeA2VHoYX1ZvmygQ8kYew40ITLAQATmM4OhgVFuXM,10482
 job_shop_lib/dispatching/__init__.py,sha256=eyiCpCWIsx3LDoSOtPImjYAkI6R8t93kz56hM03WODE,2558
-job_shop_lib/dispatching/_dispatcher.py,sha256=5zCTBIl96dcqAmdwp_1I_4V9ox2X4zMz5-ZHwpMvWGU,23765
+job_shop_lib/dispatching/_dispatcher.py,sha256=KnV_Kry3Ie81WbKhdpRQtOMsuFDNCuh5Kp2ZnelM-R8,23835
 job_shop_lib/dispatching/_dispatcher_observer_config.py,sha256=QF2d3rJWwmvutQBAkKxzQ1toJs6eMelT404LGS2z9HQ,2467
 job_shop_lib/dispatching/_factories.py,sha256=j3MhIwVXiq-B8JMit72ObvXSa2sdgWNhUD86gghL6Gg,4689
 job_shop_lib/dispatching/_history_observer.py,sha256=Vl8rQaxekUeEB-AyNxyC3c76zQakeh-rdri2iDnZvXw,610
-job_shop_lib/dispatching/_optimal_operations_observer.py,sha256=Tdclcvt_BK28eYxTzgF7Kiz1IBZAFpXRay0U62-VDHA,4211
+job_shop_lib/dispatching/_optimal_operations_observer.py,sha256=2EYxevjpeGMP3do-m0ZmtmjIjmNcxrWOSKzN_bW37gQ,4247
 job_shop_lib/dispatching/_ready_operation_filters.py,sha256=brhmhoyyoZ98wAEEfneZC-CD-aw9SerZHGMB1DpK8HY,5749
 job_shop_lib/dispatching/_start_time_calculators.py,sha256=sEtInDnFW9gsKDUEDUGQBaIjDWgCkFYvBca46j8XYfE,6408
 job_shop_lib/dispatching/_unscheduled_operations_observer.py,sha256=0he-j4OlvqtXAJZD5x1nuBnUKqZUfftVx9NT3CVxPyg,2708
 job_shop_lib/dispatching/feature_observers/__init__.py,sha256=EuJLvSpJpoXUK8A4UuC2k6Mpa293ZR3oCnnvYivIBtU,2240
-job_shop_lib/dispatching/feature_observers/_composite_feature_observer.py,sha256=FPVnrX9ySS9Bg7OpIP9FPdUeJ25Jtti3q3JvpkkHvqk,7915
+job_shop_lib/dispatching/feature_observers/_composite_feature_observer.py,sha256=tpvqTLIcNmbYROSFT62LiUZ_tI4fHWL_qCULKK43BU4,6429
 job_shop_lib/dispatching/feature_observers/_duration_observer.py,sha256=fbkUIVScF1iNjdVCYr1ImQm53TfahvVnGXhsRAsgdzY,4129
-job_shop_lib/dispatching/feature_observers/_earliest_start_time_observer.py,sha256=SOdXs-uzTzcLqOsmpbKvf-OGlGXOMVVJL9zgVVVDvF8,11442
-job_shop_lib/dispatching/feature_observers/_factory.py,sha256=DV1IlyygtffpnIMZ2AUOUKRujshIhECV1ESL7sp0P68,3288
-job_shop_lib/dispatching/feature_observers/_feature_observer.py,sha256=a7COlMWd9XC_cpEgHlsj8LEKl8Ty1g77cBm-2goSMHU,8606
+job_shop_lib/dispatching/feature_observers/_earliest_start_time_observer.py,sha256=AQIjVp7VRDnb5GuYZlLUwk-xiXSqbsxJW-Ji7NjLoAw,11452
+job_shop_lib/dispatching/feature_observers/_factory.py,sha256=NyXYK5A1hXsYEeEqngwVRNAFkevY95DglheeqyfFv8s,3217
+job_shop_lib/dispatching/feature_observers/_feature_observer.py,sha256=qbgtMUicQ5FWS-Ql4Izjsj4QrevfOGlWzoJ0JlVSLH0,8668
 job_shop_lib/dispatching/feature_observers/_is_completed_observer.py,sha256=EYJOyWL8ApUElLucoHnFlt0g2Ior_1yO7Q8V3FU_Qog,3576
 job_shop_lib/dispatching/feature_observers/_is_ready_observer.py,sha256=wy_pA-1wmnzVjhq92mdsT2JJHYbfsm79mcMgSgYUCOs,1264
 job_shop_lib/dispatching/feature_observers/_is_scheduled_observer.py,sha256=OcuMUB9_By6ZMtX-1_3z-xaxGbP85a5Zv0ywAv7XxWQ,1491
@@ -31,21 +31,20 @@ job_shop_lib/dispatching/feature_observers/_position_in_job_observer.py,sha256=W
 job_shop_lib/dispatching/feature_observers/_remaining_operations_observer.py,sha256=5V87lCrJUabEe8AkTGXPu5yS8OGxeN8L3-xNyHmdmLs,1441
 job_shop_lib/dispatching/rules/__init__.py,sha256=0Nn9FBVmxVYeDeLsd7g7WkmKFBYJqOIDzArbqsC7FAI,2187
 job_shop_lib/dispatching/rules/_dispatching_rule_factory.py,sha256=5fNpv90fAoR6rcE6NeJOWiB7ir-FVnoONIhHtKJ9H0E,2904
-job_shop_lib/dispatching/rules/_dispatching_rule_solver.py,sha256=y_H7d9u1BOXrqvRJYFgzSrYprQlg2kgcDkTeFzMuEdw,7151
-job_shop_lib/dispatching/rules/_dispatching_rules_functions.py,sha256=OldJH2ZcLq4a36yXFRiSICkKAh3RLYlvMIqKyT1OmPE,7606
+job_shop_lib/dispatching/rules/_dispatching_rule_solver.py,sha256=1_canC1lXZATrQCZaHOY3JOLmTuT6U0Z_QWzgTOLwqI,5917
+job_shop_lib/dispatching/rules/_dispatching_rules_functions.py,sha256=Yk40aKePBHHiMO6aTFeyJd1-khsDPhqit2WCOaByCfw,10998
 job_shop_lib/dispatching/rules/_machine_chooser_factory.py,sha256=CJ74ujgWXgG8cuULWY6VJkD_b3arTcOjTNLZJTAf8xE,2346
 job_shop_lib/dispatching/rules/_utils.py,sha256=m5qw4qyfaIvVrkmv51nuhreizr98-cg8AJKt2VTd48w,4603
 job_shop_lib/exceptions.py,sha256=ARzpoZJCvRIvOesCiqqFSRxkv6w9WwEXx0aBP-l2IKA,1597
 job_shop_lib/generation/__init__.py,sha256=QaWwuBfBNnOiG0OPiP_CV_flBu9dX7r2o_HwL47tREM,822
-job_shop_lib/generation/_general_instance_generator.py,sha256=Njd2vxkmSmgY-1XK-3qm_V-EnjaW_em99A7k8yR6KmU,6496
+job_shop_lib/generation/_general_instance_generator.py,sha256=b_tnyP4H_buoN7b6lKQRLvDkeZDdys0mpqS3thB5-SQ,6544
 job_shop_lib/generation/_instance_generator.py,sha256=rT7CAJuv6E0zbmRFE_MFY6iaeZB06BshsBHl2_GyPzU,4567
-job_shop_lib/generation/_transformations.py,sha256=ZigQTBsS3xgB2FhBu9MpsFs7A-_VY3840V_RtOIhCBk,5296
 job_shop_lib/generation/_utils.py,sha256=TYBGt4Zjw94l6ukIjXBVAK3lmrrZXdyzyq_r1DMlL-E,3986
 job_shop_lib/graphs/__init__.py,sha256=wlYIiXTuZRE6Kx3K0RpPUoZikzoegBuN2hcdqMODtGk,2433
 job_shop_lib/graphs/_build_disjunctive_graph.py,sha256=UbUYdeQaaeEqLchcKJGHEFGl4wElfGLb1o_R-u8wqnA,5120
-job_shop_lib/graphs/_build_resource_task_graphs.py,sha256=mWg8C-62aqvAwIKsreAHLYIq-VOc0q7BEnOnlUrywb8,6961
+job_shop_lib/graphs/_build_resource_task_graphs.py,sha256=vIy_EkQjgQAd5YyJxKAuGf7CLTjgCfhz-fYrObF4DTU,6962
 job_shop_lib/graphs/_constants.py,sha256=K-GeVvh_DTWpo1KOX1clmxWS_pkUJbq19yOBmrCVIxI,1086
-job_shop_lib/graphs/_job_shop_graph.py,sha256=4qgalP5HsVEhSxRi0UKDhBu3F_UGZV-W6G2b79tpCvA,11425
+job_shop_lib/graphs/_job_shop_graph.py,sha256=--9sbPpCiqC71kzmsPWFvMfqpx_gq4TL2x0HI2d-TEM,11427
 job_shop_lib/graphs/_node.py,sha256=Ue3_BqVPU4w9S70kDChfsMJ09spnW7Dg83osSzi7fko,5990
 job_shop_lib/graphs/graph_updaters/__init__.py,sha256=YOwb0RYypO9cEG-Nl3Ooj1yvAoyWDMNE_NAaUTyjzIw,658
 job_shop_lib/graphs/graph_updaters/_disjunctive_graph_updater.py,sha256=-t0T8W-Jz9TJQR9-ljPkcDsDC4CwJAfs2nUF3zjEtuw,4369
@@ -54,21 +53,21 @@ job_shop_lib/graphs/graph_updaters/_residual_graph_updater.py,sha256=9NG3pu7Z5h-
 job_shop_lib/graphs/graph_updaters/_utils.py,sha256=sdw2Vo75P9c6Fy-YBlfgpXb9gPwHUluTB1E-9WINm_g,730
 job_shop_lib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 job_shop_lib/reinforcement_learning/__init__.py,sha256=sAVgxylKfBnn2rrz0BFcab1kjvQQ1h-hgldfbkPF--E,1537
-job_shop_lib/reinforcement_learning/_multi_job_shop_graph_env.py,sha256=nv9F94SF5f7Xe3WZwkVG-3YD1JwipTvdL88whOT1oBg,15702
-job_shop_lib/reinforcement_learning/_resource_task_graph_observation.py,sha256=Tvgf7a-W7h_RTJ7lmoiVjed7S05wo5BVg8CFUqV1l9s,12769
+job_shop_lib/reinforcement_learning/_multi_job_shop_graph_env.py,sha256=6nXw67Tfmim3LqlSuQ9Cfg3mMY-VmbMHuXfyOL90jng,15740
+job_shop_lib/reinforcement_learning/_resource_task_graph_observation.py,sha256=ZqN6kzuXbO0BdA1UKrTEHeiHAKzRNIeuH-dBt90ttEc,12914
 job_shop_lib/reinforcement_learning/_reward_observers.py,sha256=4Kdyn9Jlp_1sBtVr6raF-ZFtcnKxwyCLykfX53TmuhU,2959
-job_shop_lib/reinforcement_learning/_single_job_shop_graph_env.py,sha256=bSnZJS4kH6YcALbkM_oVFk6paixKVKvmdSvJzTi54A0,16700
+job_shop_lib/reinforcement_learning/_single_job_shop_graph_env.py,sha256=MnQYCVpwX4WHiGhYguHziDUrPIrKmXsjOUDoTmuoCBc,16403
 job_shop_lib/reinforcement_learning/_types_and_constants.py,sha256=6FpuQkZLV2H8_dXmax49OTgAw7dWQcUEWVWWdMLR7bs,1752
 job_shop_lib/reinforcement_learning/_utils.py,sha256=aHgNdW7YvUH8QM3l7NGIfrgzfpzGoklyYm1jM2Isi6Q,6043
 job_shop_lib/visualization/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 job_shop_lib/visualization/gantt/__init__.py,sha256=xMvuNph6bfwulHYqqklCj_6SUQgRzvC92Yul75F3Zlg,1250
 job_shop_lib/visualization/gantt/_gantt_chart_creator.py,sha256=FgE4SmKLYKnS7dfTFgnBklWhwGyIo0DKWVkmxusDmp8,8606
-job_shop_lib/visualization/gantt/_gantt_chart_video_and_gif_creation.py,sha256=-6O5pNFn8frFGhPGztAFDPUUxImR06F03NY6BAA8lj8,14544
+job_shop_lib/visualization/gantt/_gantt_chart_video_and_gif_creation.py,sha256=jessyvLFgS60HEEmO7o6imo2f0uEpCLkyo-p_SBpE7Y,14571
 job_shop_lib/visualization/gantt/_plot_gantt_chart.py,sha256=_4UGUTRuIw0tLzsJD9Gcf10aIy2YkDzTGsNTzFb5r0Y,6809
 job_shop_lib/visualization/graphs/__init__.py,sha256=HUWzfgQLeklNROtjnxeJX_FIySo_baTXO6klx0zUVpQ,630
-job_shop_lib/visualization/graphs/_plot_disjunctive_graph.py,sha256=YyNEKgg1ol34JYu8Ej1kKonsuFu7zDav4uuUzU_FS4Q,15905
-job_shop_lib/visualization/graphs/_plot_resource_task_graph.py,sha256=Sp1aokyM_8QZb39QCLrjQECcbDHkdcYw7wMZILWxN9o,13191
-job_shop_lib-1.1.1.dist-info/LICENSE,sha256=9mggivMGd5taAu3xbmBway-VQZMBzurBGHofFopvUsQ,1069
-job_shop_lib-1.1.1.dist-info/METADATA,sha256=vLOLmhRtfTA-dyIA985M23OiuMi8UMPxGaX3wAGrnlU,16397
-job_shop_lib-1.1.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-job_shop_lib-1.1.1.dist-info/RECORD,,
+job_shop_lib/visualization/graphs/_plot_disjunctive_graph.py,sha256=L9_ZGgvCFpGc2rTOdZESdtydFQqShjqedimIOhqZx6Y,16209
+job_shop_lib/visualization/graphs/_plot_resource_task_graph.py,sha256=nkkdZ-9_OBevw72Frecwzv1y3WyhGZ9r9lz0y9MXvZ8,13192
+job_shop_lib-1.1.3.dist-info/LICENSE,sha256=9mggivMGd5taAu3xbmBway-VQZMBzurBGHofFopvUsQ,1069
+job_shop_lib-1.1.3.dist-info/METADATA,sha256=O0G7p67y75GHe-gVPEepppAQGETiswCfkaB7JmbmwnI,19130
+job_shop_lib-1.1.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+job_shop_lib-1.1.3.dist-info/RECORD,,

job_shop_lib/generation/_transformations.py

@@ -1,167 +0,0 @@
-"""Classes for generating transformed JobShopInstance objects."""
-
-import abc
-import copy
-import random
-
-from job_shop_lib import JobShopInstance, Operation
-
-
-class Transformation(abc.ABC):
-    """Base class for transformations applied to JobShopInstance objects."""
-
-    def __init__(self, suffix: str = ""):
-        self.suffix = suffix
-        self.counter = 0
-
-    @abc.abstractmethod
-    def apply(self, instance: JobShopInstance) -> JobShopInstance:
-        """Applies the transformation to a given JobShopInstance.
-
-        Args:
-            instance: The JobShopInstance to transform.
-
-        Returns:
-            A new JobShopInstance with the transformation applied.
-        """
-
-    def __call__(self, instance: JobShopInstance) -> JobShopInstance:
-        instance = self.apply(instance)
-        suffix = f"{self.suffix}_id={self.counter}"
-        instance.name += suffix
-        self.counter += 1
-        return instance
-
-
-# pylint: disable=too-few-public-methods
-class RemoveMachines(Transformation):
-    """Removes operations associated with randomly selected machines until
-    there are exactly num_machines machines left."""
-
-    def __init__(self, num_machines: int, suffix: str | None = None):
-        if suffix is None:
-            suffix = f"_machines={num_machines}"
-        super().__init__(suffix=suffix)
-        self.num_machines = num_machines
-
-    def apply(self, instance: JobShopInstance) -> JobShopInstance:
-        if instance.num_machines <= self.num_machines:
-            return instance  # No need to remove machines
-
-        # Select machine indices to keep
-        machines_to_keep = set(
-            random.sample(range(instance.num_machines), self.num_machines)
-        )
-
-        # Re-index machines
-        machine_reindex_map = {
-            old_id: new_id
-            for new_id, old_id in enumerate(sorted(machines_to_keep))
-        }
-
-        new_jobs = []
-        for job in instance.jobs:
-            # Keep operations whose machine_id is in machines_to_keep and
-            # re-index them
-            new_jobs.append(
-                [
-                    Operation(machine_reindex_map[op.machine_id], op.duration)
-                    for op in job
-                    if op.machine_id in machines_to_keep
-                ]
-            )
-
-        return JobShopInstance(new_jobs, instance.name)
-
-
-# pylint: disable=too-few-public-methods
-class AddDurationNoise(Transformation):
-    """Adds uniform integer noise to operation durations."""
-
-    def __init__(
-        self,
-        min_duration: int = 1,
-        max_duration: int = 100,
-        noise_level: int = 10,
-        suffix: str | None = None,
-    ):
-        if suffix is None:
-            suffix = f"_noise={noise_level}"
-        super().__init__(suffix=suffix)
-        self.min_duration = min_duration
-        self.max_duration = max_duration
-        self.noise_level = noise_level
-
-    def apply(self, instance: JobShopInstance) -> JobShopInstance:
-        new_jobs = []
-        for job in instance.jobs:
-            new_job = []
-            for op in job:
-                noise = random.randint(-self.noise_level, self.noise_level)
-                new_duration = max(
-                    self.min_duration,
-                    min(self.max_duration, op.duration + noise),
-                )
-
-                new_job.append(Operation(op.machine_id, new_duration))
-            new_jobs.append(new_job)
-
-        return JobShopInstance(new_jobs, instance.name)
-
-
-class RemoveJobs(Transformation):
-    """Removes jobs randomly until the number of jobs is within a specified
-    range.
-
-    Args:
-        min_jobs:
-            The minimum number of jobs to remain in the instance.
-        max_jobs:
-            The maximum number of jobs to remain in the instance.
-        target_jobs:
-            If specified, the number of jobs to remain in the
-            instance. Overrides ``min_jobs`` and ``max_jobs``.
-    """
-
-    def __init__(
-        self,
-        min_jobs: int,
-        max_jobs: int,
-        target_jobs: int | None = None,
-        suffix: str | None = None,
-    ):
-        if suffix is None:
-            suffix = f"_jobs={min_jobs}-{max_jobs}"
-        super().__init__(suffix=suffix)
-        self.min_jobs = min_jobs
-        self.max_jobs = max_jobs
-        self.target_jobs = target_jobs
-
-    def apply(self, instance: JobShopInstance) -> JobShopInstance:
-        if self.target_jobs is None:
-            target_jobs = random.randint(self.min_jobs, self.max_jobs)
-        else:
-            target_jobs = self.target_jobs
-        new_jobs = copy.deepcopy(instance.jobs)
-
-        while len(new_jobs) > target_jobs:
-            new_jobs.pop(random.randint(0, len(new_jobs) - 1))
-
-        return JobShopInstance(new_jobs, instance.name)
-
-    @staticmethod
-    def remove_job(
-        instance: JobShopInstance, job_index: int
-    ) -> JobShopInstance:
-        """Removes a specific job from the instance.
-
-        Args:
-            instance: The JobShopInstance from which to remove the job.
-            job_index: The index of the job to remove.
-
-        Returns:
-            A new JobShopInstance with the specified job removed.
-        """
-        new_jobs = copy.deepcopy(instance.jobs)
-        new_jobs.pop(job_index)
-        return JobShopInstance(new_jobs, instance.name)