job-shop-lib 1.0.2__py3-none-any.whl → 1.0.3__py3-none-any.whl

job_shop_lib/generation/_general_instance_generator.py

@@ -1,7 +1,4 @@
-"""Home of the `BasicGenerator` class."""
-
-from typing import Optional, Tuple, Union
-import random
+import numpy as np
 
 from job_shop_lib import JobShopInstance
 from job_shop_lib.exceptions import ValidationError
@@ -79,17 +76,18 @@ class GeneralInstanceGenerator(InstanceGenerator):
             Maximum number of instances to generate in iteration mode.
     """
 
-    def __init__(  # pylint: disable=too-many-arguments
+    # pylint: disable=too-many-arguments
+    def __init__(  # pylint: disable=too-many-positional-arguments
         self,
-        num_jobs: Union[int, Tuple[int, int]] = (10, 20),
-        num_machines: Union[int, Tuple[int, int]] = (5, 10),
-        duration_range: Tuple[int, int] = (1, 99),
+        num_jobs: int | tuple[int, int] = (10, 20),
+        num_machines: int | tuple[int, int] = (5, 10),
+        duration_range: tuple[int, int] = (1, 99),
         allow_less_jobs_than_machines: bool = True,
         allow_recirculation: bool = False,
-        machines_per_operation: Union[int, Tuple[int, int]] = 1,
+        machines_per_operation: int | tuple[int, int] = 1,
         name_suffix: str = "classic_generated_instance",
-        seed: Optional[int] = None,
-        iteration_limit: Optional[int] = None,
+        seed: int | None = None,
+        iteration_limit: int | None = None,
     ):
         super().__init__(
             num_jobs=num_jobs,
@@ -114,8 +112,8 @@ class GeneralInstanceGenerator(InstanceGenerator):
         self.allow_recirculation = allow_recirculation
         self.name_suffix = name_suffix
 
-        if seed is not None:
-            random.seed(seed)
+        # Create a dedicated random number generator instance
+        self.rng = np.random.default_rng(seed)
 
     def __repr__(self) -> str:
         return (
@@ -127,17 +125,21 @@ class GeneralInstanceGenerator(InstanceGenerator):
 
     def generate(
         self,
-        num_jobs: Optional[int] = None,
-        num_machines: Optional[int] = None,
+        num_jobs: int | None = None,
+        num_machines: int | None = None,
     ) -> JobShopInstance:
         if num_jobs is None:
-            num_jobs = random.randint(*self.num_jobs_range)
+            num_jobs = 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 = random.randint(min_num_machines, max_num_machines)
+            num_machines = self.rng.integers(
+                min_num_machines, max_num_machines + 1
+            )
         elif (
             not self.allow_less_jobs_than_machines and num_jobs < num_machines
         ):
@@ -147,15 +149,15 @@ class GeneralInstanceGenerator(InstanceGenerator):
             )
 
         duration_matrix = generate_duration_matrix(
-            num_jobs, num_machines, self.duration_range
+            num_jobs, num_machines, self.duration_range, self.rng
         )
         if self.allow_recirculation:
             machine_matrix = generate_machine_matrix_with_recirculation(
-                num_jobs, num_machines
+                num_jobs, num_machines, self.rng
             )
         else:
             machine_matrix = generate_machine_matrix_without_recirculation(
-                num_jobs, num_machines
+                num_jobs, num_machines, self.rng
             )
 
         return JobShopInstance.from_matrices(

job_shop_lib/generation/_instance_generator.py

@@ -3,7 +3,7 @@
 import abc
 
 import random
-from typing import Iterator, Optional, Tuple, Union
+from typing import Iterator
 
 from job_shop_lib import JobShopInstance
 from job_shop_lib.exceptions import UninitializedAttributeError
@@ -52,12 +52,12 @@ class InstanceGenerator(abc.ABC):
 
     def __init__(  # pylint: disable=too-many-arguments
         self,
-        num_jobs: Union[int, Tuple[int, int]] = (10, 20),
-        num_machines: Union[int, Tuple[int, int]] = (5, 10),
-        duration_range: Tuple[int, int] = (1, 99),
+        num_jobs: int | tuple[int, int] = (10, 20),
+        num_machines: int | tuple[int, int] = (5, 10),
+        duration_range: tuple[int, int] = (1, 99),
         name_suffix: str = "generated_instance",
-        seed: Optional[int] = None,
-        iteration_limit: Optional[int] = None,
+        seed: int | None = None,
+        iteration_limit: int | None = None,
     ):
         if isinstance(num_jobs, int):
             num_jobs = (num_jobs, num_jobs)
@@ -78,8 +78,8 @@ class InstanceGenerator(abc.ABC):
     @abc.abstractmethod
     def generate(
         self,
-        num_jobs: Optional[int] = None,
-        num_machines: Optional[int] = None,
+        num_jobs: int | None = None,
+        num_machines: int | None = None,
     ) -> JobShopInstance:
         """Generates a single job shop instance
 

job_shop_lib/generation/_transformations.py

@@ -3,7 +3,6 @@
 import abc
 import copy
 import random
-from typing import Optional
 
 from job_shop_lib import JobShopInstance, Operation
 
@@ -39,7 +38,7 @@ 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: Optional[str] = None):
+    def __init__(self, num_machines: int, suffix: str | None = None):
         if suffix is None:
             suffix = f"_machines={num_machines}"
         super().__init__(suffix=suffix)
@@ -84,7 +83,7 @@ class AddDurationNoise(Transformation):
         min_duration: int = 1,
         max_duration: int = 100,
         noise_level: int = 10,
-        suffix: Optional[str] = None,
+        suffix: str | None = None,
     ):
         if suffix is None:
             suffix = f"_noise={noise_level}"
@@ -128,8 +127,8 @@ class RemoveJobs(Transformation):
         self,
         min_jobs: int,
         max_jobs: int,
-        target_jobs: Optional[int] = None,
-        suffix: Optional[str] = None,
+        target_jobs: int | None = None,
+        suffix: str | None = None,
     ):
         if suffix is None:
             suffix = f"_jobs={min_jobs}-{max_jobs}"

job_shop_lib/generation/_utils.py

@@ -1,4 +1,3 @@
-from typing import Tuple
 import numpy as np
 from numpy.typing import NDArray
 
@@ -6,7 +5,10 @@ from job_shop_lib.exceptions import ValidationError
 
 
 def generate_duration_matrix(
-    num_jobs: int, num_machines: int, duration_range: Tuple[int, int]
+    num_jobs: int,
+    num_machines: int,
+    duration_range: tuple[int, int],
+    rng: np.random.Generator | None = None,
 ) -> NDArray[np.int32]:
     """Generates a duration matrix.
 
@@ -14,10 +16,12 @@ def generate_duration_matrix(
         num_jobs: The number of jobs.
         num_machines: The number of machines.
         duration_range: The range of the duration values.
+        rng: A numpy random number generator.
 
     Returns:
         A duration matrix with shape (num_jobs, num_machines).
     """
+    rng = rng or np.random.default_rng()
     if duration_range[0] > duration_range[1]:
         raise ValidationError(
             "The lower bound of the duration range must be less than or equal "
@@ -28,7 +32,7 @@ def generate_duration_matrix(
     if num_machines <= 0:
         raise ValidationError("The number of machines must be greater than 0.")
 
-    return np.random.randint(
+    return rng.integers(
         duration_range[0],
         duration_range[1] + 1,
         size=(num_jobs, num_machines),
@@ -37,26 +41,28 @@ def generate_duration_matrix(
 
 
 def generate_machine_matrix_with_recirculation(
-    num_jobs: int, num_machines: int
+    num_jobs: int, num_machines: int, rng: np.random.Generator | None = None
 ) -> NDArray[np.int32]:
     """Generate a machine matrix with recirculation.
 
     Args:
         num_jobs: The number of jobs.
         num_machines: The number of machines.
+        rng: A numpy random number generator.
 
     Returns:
         A machine matrix with recirculation with shape (num_machines,
         num_jobs).
     """
+    rng = rng or np.random.default_rng()
     if num_jobs <= 0:
         raise ValidationError("The number of jobs must be greater than 0.")
     if num_machines <= 0:
         raise ValidationError("The number of machines must be greater than 0.")
     num_machines_is_correct = False
     while not num_machines_is_correct:
-        machine_matrix: np.ndarray = np.random.randint(
-            0, num_machines, size=(num_machines, num_jobs)
+        machine_matrix: np.ndarray = rng.integers(
+            0, num_machines, size=(num_machines, num_jobs), dtype=np.int32
         )
         num_machines_is_correct = (
             len(np.unique(machine_matrix)) == num_machines
@@ -66,17 +72,19 @@ def generate_machine_matrix_with_recirculation(
 
 
 def generate_machine_matrix_without_recirculation(
-    num_jobs: int, num_machines: int
+    num_jobs: int, num_machines: int, rng: np.random.Generator | None = None
 ) -> NDArray[np.int32]:
     """Generate a machine matrix without recirculation.
 
     Args:
         num_jobs: The number of jobs.
         num_machines: The number of machines.
+        rng: A numpy random number generator.
 
     Returns:
         A machine matrix without recirculation.
     """
+    rng = rng or np.random.default_rng()
     if num_jobs <= 0:
         raise ValidationError("The number of jobs must be greater than 0.")
     if num_machines <= 0:
@@ -91,7 +99,7 @@ def generate_machine_matrix_without_recirculation(
     )
     # Shuffle the columns:
     machine_matrix = np.apply_along_axis(
-        np.random.permutation, 1, machine_matrix
+        rng.permutation, 1, machine_matrix
     )
     return machine_matrix
 

job_shop_lib/graphs/_job_shop_graph.py

@@ -1,6 +1,5 @@
 """Home of the `JobShopGraph` class."""
 
-from typing import List, Union, Dict
 import collections
 import networkx as nx
 
@@ -63,23 +62,23 @@ class JobShopGraph:
         self.graph = nx.DiGraph()
         self.instance = instance
 
-        self._nodes: List[Node] = []
-        self._nodes_by_type: Dict[NodeType, List[Node]] = (
+        self._nodes: list[Node] = []
+        self._nodes_by_type: dict[NodeType, list[Node]] = (
             collections.defaultdict(list)
         )
-        self._nodes_by_machine: List[List[Node]] = [
+        self._nodes_by_machine: list[list[Node]] = [
             [] for _ in range(instance.num_machines)
         ]
-        self._nodes_by_job: List[List[Node]] = [
+        self._nodes_by_job: list[list[Node]] = [
             [] for _ in range(instance.num_jobs)
         ]
         self._next_node_id = 0
-        self.removed_nodes: List[bool] = []
+        self.removed_nodes: list[bool] = []
         if add_operation_nodes:
             self.add_operation_nodes()
 
     @property
-    def nodes(self) -> List[Node]:
+    def nodes(self) -> list[Node]:
         """List of all nodes added to the graph.
 
         It may contain nodes that have been removed from the graph.
@@ -87,7 +86,7 @@ class JobShopGraph:
         return self._nodes
 
     @property
-    def nodes_by_type(self) -> Dict[NodeType, List[Node]]:
+    def nodes_by_type(self) -> dict[NodeType, list[Node]]:
         """Dictionary mapping node types to lists of nodes.
 
         It may contain nodes that have been removed from the graph.
@@ -95,7 +94,7 @@ class JobShopGraph:
         return self._nodes_by_type
 
     @property
-    def nodes_by_machine(self) -> List[List[Node]]:
+    def nodes_by_machine(self) -> list[list[Node]]:
         """List of lists mapping machine ids to operation nodes.
 
         It may contain nodes that have been removed from the graph.
@@ -103,7 +102,7 @@ class JobShopGraph:
         return self._nodes_by_machine
 
     @property
-    def nodes_by_job(self) -> List[List[Node]]:
+    def nodes_by_job(self) -> list[list[Node]]:
         """List of lists mapping job ids to operation nodes.
 
         It may contain nodes that have been removed from the graph.
@@ -163,8 +162,8 @@ class JobShopGraph:
 
     def add_edge(
         self,
-        u_of_edge: Union[Node, int],
-        v_of_edge: Union[Node, int],
+        u_of_edge: Node | int,
+        v_of_edge: Node | int,
         **attr,
     ) -> None:
         """Adds an edge to the graph.
@@ -228,7 +227,7 @@ class JobShopGraph:
 
         self.graph.remove_nodes_from(isolated_nodes)
 
-    def is_removed(self, node: Union[int, Node]) -> bool:
+    def is_removed(self, node: int | Node) -> bool:
         """Returns whether the node is removed from the graph.
 
         Args:
@@ -241,7 +240,7 @@ class JobShopGraph:
             node = node.node_id
         return self.removed_nodes[node]
 
-    def non_removed_nodes(self) -> List[Node]:
+    def non_removed_nodes(self) -> list[Node]:
         """Returns the nodes that are not removed from the graph."""
         return [node for node in self._nodes if not self.is_removed(node)]
 

job_shop_lib/graphs/_node.py

@@ -1,7 +1,5 @@
 """Home of the `Node` class."""
 
-from typing import Optional
-
 from job_shop_lib import Operation
 from job_shop_lib.exceptions import (
     UninitializedAttributeError,
@@ -70,21 +68,17 @@ class Node:
     __slots__ = {
         "node_type": "The type of the node.",
         "_node_id": "Unique identifier for the node.",
-        "_operation": (
-            "The operation associated with the node."
-        ),
-        "_machine_id": (
-            "The machine ID associated with the node."
-        ),
+        "_operation": ("The operation associated with the node."),
+        "_machine_id": ("The machine ID associated with the node."),
         "_job_id": "The job ID associated with the node.",
     }
 
     def __init__(
         self,
         node_type: NodeType,
-        operation: Optional[Operation] = None,
-        machine_id: Optional[int] = None,
-        job_id: Optional[int] = None,
+        operation: Operation | None = None,
+        machine_id: int | None = None,
+        job_id: int | None = None,
     ):
         if node_type == NodeType.OPERATION and operation is None:
             raise ValidationError("Operation node must have an operation.")
@@ -96,7 +90,7 @@ class Node:
             raise ValidationError("Job node must have a job_id.")
 
         self.node_type: NodeType = node_type
-        self._node_id: Optional[int] = None
+        self._node_id: int | None = None
 
         self._operation = operation
         self._machine_id = machine_id

job_shop_lib/graphs/graph_updaters/_residual_graph_updater.py

@@ -1,7 +1,5 @@
 """Home of the `ResidualGraphUpdater` class."""
 
-from typing import Optional, List
-
 from job_shop_lib import ScheduledOperation
 from job_shop_lib.exceptions import UninitializedAttributeError
 from job_shop_lib.graphs import NodeType, JobShopGraph
@@ -56,7 +54,7 @@ class ResidualGraphUpdater(GraphUpdater):
         remove_completed_machine_nodes: bool = True,
         remove_completed_job_nodes: bool = True,
     ):
-        self._is_completed_observer: Optional[IsCompletedObserver] = None
+        self._is_completed_observer: IsCompletedObserver | None = None
         self.remove_completed_job_nodes = remove_completed_job_nodes
         self.remove_completed_machine_nodes = remove_completed_machine_nodes
         self._initialize_is_completed_observer_attribute(dispatcher)
@@ -82,7 +80,7 @@ class ResidualGraphUpdater(GraphUpdater):
                     return False
             return True
 
-        feature_types: List[FeatureType] = []
+        feature_types: list[FeatureType] = []
         if self.remove_completed_machine_nodes:
             feature_types.append(FeatureType.MACHINES)
         if self.remove_completed_job_nodes:

job_shop_lib/reinforcement_learning/__init__.py

@@ -48,7 +48,8 @@ from job_shop_lib.reinforcement_learning._multi_job_shop_graph_env import (
     MultiJobShopGraphEnv,
 )
 from ._resource_task_graph_observation import (
-    ResourceTaskGraphObservation, ResourceTaskGraphObservationDict
+    ResourceTaskGraphObservation,
+    ResourceTaskGraphObservationDict,
 )
 
 

job_shop_lib/reinforcement_learning/_multi_job_shop_graph_env.py

@@ -2,7 +2,7 @@
 
 from collections import defaultdict
 from collections.abc import Callable, Sequence
-from typing import Any, Tuple, Dict, List, Optional, Type
+from typing import Any
 from copy import deepcopy
 
 import gymnasium as gym
@@ -162,16 +162,16 @@ class MultiJobShopGraphEnv(gym.Env):
             [JobShopInstance], JobShopGraph
         ] = build_resource_task_graph,
         graph_updater_config: DispatcherObserverConfig[
-            Type[GraphUpdater]
+            type[GraphUpdater]
         ] = DispatcherObserverConfig(class_type=ResidualGraphUpdater),
         ready_operations_filter: Callable[
-            [Dispatcher, List[Operation]], List[Operation]
+            [Dispatcher, list[Operation]], list[Operation]
         ] = filter_dominated_operations,
         reward_function_config: DispatcherObserverConfig[
-            Type[RewardObserver]
+            type[RewardObserver]
         ] = DispatcherObserverConfig(class_type=MakespanReward),
-        render_mode: Optional[str] = None,
-        render_config: Optional[RenderConfig] = None,
+        render_mode: str | None = None,
+        render_config: RenderConfig | None = None,
         use_padding: bool = True,
     ) -> None:
         super().__init__()
@@ -226,7 +226,7 @@ class MultiJobShopGraphEnv(gym.Env):
     @property
     def ready_operations_filter(
         self,
-    ) -> Optional[Callable[[Dispatcher, List[Operation]], List[Operation]]]:
+    ) -> Callable[[Dispatcher, list[Operation]], list[Operation]] | None:
         """Returns the current ready operations filter."""
         return (
             self.single_job_shop_graph_env.dispatcher.ready_operations_filter
@@ -236,7 +236,7 @@ class MultiJobShopGraphEnv(gym.Env):
     def ready_operations_filter(
         self,
         ready_operations_filter: Callable[
-            [Dispatcher, List[Operation]], List[Operation]
+            [Dispatcher, list[Operation]], list[Operation]
         ],
     ) -> None:
         """Sets the ready operations filter."""
@@ -267,9 +267,9 @@ class MultiJobShopGraphEnv(gym.Env):
     def reset(
         self,
         *,
-        seed: Optional[int] = None,
-        options: Dict[str, Any] | None = None,
-    ) -> Tuple[ObservationDict, Dict[str, Any]]:
+        seed: int | None = None,
+        options: dict[str, Any] | None = None,
+    ) -> tuple[ObservationDict, dict[str, Any]]:
         """Resets the environment and returns the initial observation.
 
         Args:
@@ -303,8 +303,8 @@ class MultiJobShopGraphEnv(gym.Env):
         return obs, info
 
     def step(
-        self, action: Tuple[int, int]
-    ) -> Tuple[ObservationDict, float, bool, bool, Dict[str, Any]]:
+        self, action: tuple[int, int]
+    ) -> tuple[ObservationDict, float, bool, bool, dict[str, Any]]:
         """Takes a step in the environment.
 
         Args:
@@ -356,7 +356,7 @@ class MultiJobShopGraphEnv(gym.Env):
             input_shape: (num_machines, num_features)
             output_shape: (max_num_machines, num_features) (padded with -1)
         """
-        padding_value: Dict[str, float | bool] = defaultdict(lambda: -1)
+        padding_value: dict[str, float | bool] = defaultdict(lambda: -1)
         padding_value[ObservationSpaceKey.REMOVED_NODES.value] = True
         for key, value in observation.items():
             if not isinstance(value, np.ndarray):  # Make mypy happy
@@ -369,7 +369,7 @@ class MultiJobShopGraphEnv(gym.Env):
             )
         return observation
 
-    def _get_output_shape(self, key: str) -> Tuple[int, ...]:
+    def _get_output_shape(self, key: str) -> tuple[int, ...]:
         """Returns the output shape of the observation space key."""
         output_shape = self.observation_space[key].shape
         assert output_shape is not None  # Make mypy happy
@@ -378,12 +378,12 @@ class MultiJobShopGraphEnv(gym.Env):
     def render(self) -> None:
         self.single_job_shop_graph_env.render()
 
-    def get_available_actions_with_ids(self) -> List[Tuple[int, int, int]]:
+    def get_available_actions_with_ids(self) -> list[tuple[int, int, int]]:
         """Returns a list of available actions in the form of
         (operation_id, machine_id, job_id)."""
         return self.single_job_shop_graph_env.get_available_actions_with_ids()
 
-    def validate_action(self, action: Tuple[int, int]) -> None:
+    def validate_action(self, action: tuple[int, int]) -> None:
         """Validates the action.
 
         Args:

job_shop_lib/reinforcement_learning/_resource_task_graph_observation.py

@@ -245,7 +245,7 @@ class ResourceTaskGraphObservation(ObservationWrapper, Generic[EnvType]):
 
     @staticmethod
     def _get_start_from_zero_mappings(
-        original_indices_dict: dict[str, NDArray[np.int32]]
+        original_indices_dict: dict[str, NDArray[np.int32]],
     ) -> dict[str, dict[int, int]]:
         mappings = {}
         for key, indices in original_indices_dict.items():

job_shop_lib/reinforcement_learning/_reward_observers.py

@@ -1,8 +1,6 @@
 """Rewards functions are defined as `DispatcherObervers` and are used to
 calculate the reward for a given state."""
 
-from typing import List
-
 from job_shop_lib.dispatching import DispatcherObserver, Dispatcher
 from job_shop_lib import ScheduledOperation
 
@@ -20,7 +18,7 @@ class RewardObserver(DispatcherObserver):
         self, dispatcher: Dispatcher, *, subscribe: bool = True
     ) -> None:
         super().__init__(dispatcher, subscribe=subscribe)
-        self.rewards: List[float] = []
+        self.rewards: list[float] = []
 
     @property
     def last_reward(self) -> float: