job-shop-lib 1.0.1__tar.gz → 1.0.3__tar.gz

{job_shop_lib-1.0.1 → job_shop_lib-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 1.0.1
+Version: 1.0.3
 Summary: An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)
 License: MIT
 Author: Pabloo22
@@ -40,7 +40,11 @@ JobShopLib is a Python package for creating, solving, and visualizing job shop s
 
 It follows a modular design, allowing users to easily extend the library with new solvers, dispatching rules, visualization functions, etc.
 
-See the [documentation](https://job-shop-lib.readthedocs.io/en/latest/) for more details about the latest version.
+There is a [documentation page](https://job-shop-lib.readthedocs.io/en/stable/) for versions 1.0.0a3 and onward. See the [latest pull requests](https://github.com/Pabloo22/job_shop_lib/pulls?q=is%3Apr+is%3Aclosed) for the latest changes.
+
+See [`gnn_scheduler`](https://github.com/Pabloo22/gnn_scheduler/blob/main/gnn_scheduler/) for an example implementation of a graph neural network-based dispatcher trained with [PyTorch Geometric](https://pyg.org/).
+
+See [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! More advanced examples can be found [here](https://job-shop-lib.readthedocs.io/en/stable/examples.html).
 
 ## Installation :package:
 
@@ -54,11 +58,6 @@ You can install the latest stable version using `pip`:
 pip install job-shop-lib
 ```
 
-See [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
-
-
-There is a [documentation page](https://job-shop-lib.readthedocs.io/en/latest/) for versions 1.0.0a3 and onward. See see the [latest pull requests](https://github.com/Pabloo22/job_shop_lib/pulls?q=is%3Apr+is%3Aclosed) for the latest changes.
-
 <!-- end installation -->
 
 <!-- key features -->
@@ -252,7 +251,15 @@ Additionally, the graph includes **disjunctive edges** between operations that u
 ```python
 from job_shop_lib.visualization import plot_disjunctive_graph
 
-fig = plot_disjunctive_graph(instance)
+fig = plot_disjunctive_graph(
+    instance,
+    figsize=(6, 4),
+    draw_disjunctive_edges="single_edge",
+    disjunctive_edges_additional_params={
+        "arrowstyle": "<|-|>",
+        "connectionstyle": "arc3,rad=0.15",
+    },
+)
 plt.show()
 ```
 
@@ -308,9 +315,9 @@ from job_shop_lib.graphs import (
 )
 from job_shop_lib.visualization import plot_resource_task_graph
 
-complete_resource_task_graph = build_complete_resource_task_graph(instance)
+resource_task_graph = build_resource_task_graph(instance)
 
-fig = plot_resource_task_graph(complete_agent_task_graph)
+fig = plot_resource_task_graph(resource_task_graph)
 plt.show()
 ```
 

{job_shop_lib-1.0.1 → job_shop_lib-1.0.3}/README.md

@@ -16,7 +16,11 @@ JobShopLib is a Python package for creating, solving, and visualizing job shop s
 
 It follows a modular design, allowing users to easily extend the library with new solvers, dispatching rules, visualization functions, etc.
 
-See the [documentation](https://job-shop-lib.readthedocs.io/en/latest/) for more details about the latest version.
+There is a [documentation page](https://job-shop-lib.readthedocs.io/en/stable/) for versions 1.0.0a3 and onward. See the [latest pull requests](https://github.com/Pabloo22/job_shop_lib/pulls?q=is%3Apr+is%3Aclosed) for the latest changes.
+
+See [`gnn_scheduler`](https://github.com/Pabloo22/gnn_scheduler/blob/main/gnn_scheduler/) for an example implementation of a graph neural network-based dispatcher trained with [PyTorch Geometric](https://pyg.org/).
+
+See [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! More advanced examples can be found [here](https://job-shop-lib.readthedocs.io/en/stable/examples.html).
 
 ## Installation :package:
 
@@ -30,11 +34,6 @@ You can install the latest stable version using `pip`:
 pip install job-shop-lib
 ```
 
-See [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
-
-
-There is a [documentation page](https://job-shop-lib.readthedocs.io/en/latest/) for versions 1.0.0a3 and onward. See see the [latest pull requests](https://github.com/Pabloo22/job_shop_lib/pulls?q=is%3Apr+is%3Aclosed) for the latest changes.
-
 <!-- end installation -->
 
 <!-- key features -->
@@ -228,7 +227,15 @@ Additionally, the graph includes **disjunctive edges** between operations that u
 ```python
 from job_shop_lib.visualization import plot_disjunctive_graph
 
-fig = plot_disjunctive_graph(instance)
+fig = plot_disjunctive_graph(
+    instance,
+    figsize=(6, 4),
+    draw_disjunctive_edges="single_edge",
+    disjunctive_edges_additional_params={
+        "arrowstyle": "<|-|>",
+        "connectionstyle": "arc3,rad=0.15",
+    },
+)
 plt.show()
 ```
 
@@ -284,9 +291,9 @@ from job_shop_lib.graphs import (
 )
 from job_shop_lib.visualization import plot_resource_task_graph
 
-complete_resource_task_graph = build_complete_resource_task_graph(instance)
+resource_task_graph = build_resource_task_graph(instance)
 
-fig = plot_resource_task_graph(complete_agent_task_graph)
+fig = plot_resource_task_graph(resource_task_graph)
 plt.show()
 ```
 

{job_shop_lib-1.0.1 → job_shop_lib-1.0.3}/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.0.1"
+__version__ = "1.0.3"
 
 __all__ = [
     "Operation",

{job_shop_lib-1.0.1 → job_shop_lib-1.0.3}/job_shop_lib/_job_shop_instance.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import os
 import functools
-from typing import Any, List, Union, Dict
+from typing import Any
 
 import numpy as np
 from numpy.typing import NDArray
@@ -16,8 +16,8 @@ class JobShopInstance:
     """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 if they
-    require expensive computations.
+    be computed from the instance and are cached for performance since they
+    might require expensive computations.
 
     Methods:
 
@@ -51,14 +51,14 @@ class JobShopInstance:
         total_duration
 
     Attributes:
-        jobs (List[List[Operation]]):
+        jobs (list[list[Operation]]):
             A list of lists of operations. Each list of operations represents
             a job, and the operations are ordered by their position in the job.
             The ``job_id``, ``position_in_job``, and ``operation_id``
             attributes of the operations are set when the instance is created.
         name (str):
             A string with the name of the instance.
-        metadata (Dict[str, Any]):
+        metadata (dict[str, Any]):
             A dictionary with additional information about the instance.
 
     Args:
@@ -81,16 +81,16 @@ class JobShopInstance:
 
     def __init__(
         self,
-        jobs: List[List[Operation]],
+        jobs: list[list[Operation]],
         name: str = "JobShopInstance",
         set_operation_attributes: bool = True,
         **metadata: Any,
     ):
-        self.jobs: List[List[Operation]] = jobs
+        self.jobs: list[list[Operation]] = jobs
         if set_operation_attributes:
             self.set_operation_attributes()
         self.name: str = name
-        self.metadata: Dict[str, Any] = metadata
+        self.metadata: dict[str, Any] = metadata
 
     def set_operation_attributes(self):
         """Sets the ``job_id``, ``position_in_job``, and ``operation_id``
@@ -125,10 +125,10 @@ class JobShopInstance:
     @classmethod
     def from_taillard_file(
         cls,
-        file_path: Union[os.PathLike, str, bytes],
+        file_path: os.PathLike | str | bytes,
         encoding: str = "utf-8",
         comment_symbol: str = "#",
-        name: Union[str, None] = None,
+        name: str | None = None,
         **metadata: Any,
     ) -> JobShopInstance:
         """Creates a JobShopInstance from a file following Taillard's format.
@@ -178,7 +178,7 @@ class JobShopInstance:
                 name = name.split(".")[0]
         return cls(jobs=jobs, name=name, **metadata)
 
-    def to_dict(self) -> Dict[str, Any]:
+    def to_dict(self) -> dict[str, Any]:
         """Returns a dictionary representation of the instance.
 
         This representation is useful for saving the instance to a JSON file,
@@ -186,7 +186,7 @@ class JobShopInstance:
         like Taillard's.
 
         Returns:
-            Dict[str, Any]: The returned dictionary has the following
+            dict[str, Any]: The returned dictionary has the following
             structure:
 
             .. code-block:: python
@@ -208,10 +208,10 @@ class JobShopInstance:
     @classmethod
     def from_matrices(
         cls,
-        duration_matrix: List[List[int]],
-        machines_matrix: List[List[List[int]]] | List[List[int]],
+        duration_matrix: list[list[int]],
+        machines_matrix: list[list[list[int]]] | list[list[int]],
         name: str = "JobShopInstance",
-        metadata: Dict[str, Any] | None = None,
+        metadata: dict[str, Any] | None = None,
     ) -> JobShopInstance:
         """Creates a :class:`JobShopInstance` from duration and machines
         matrices.
@@ -233,7 +233,7 @@ class JobShopInstance:
         Returns:
             A :class:`JobShopInstance` object.
         """
-        jobs: List[List[Operation]] = [[] for _ in range(len(duration_matrix))]
+        jobs: list[list[Operation]] = [[] for _ in range(len(duration_matrix))]
 
         num_jobs = len(duration_matrix)
         for job_id in range(num_jobs):
@@ -290,7 +290,7 @@ class JobShopInstance:
         )
 
     @functools.cached_property
-    def durations_matrix(self) -> List[List[int]]:
+    def durations_matrix(self) -> list[list[int]]:
         """Returns the duration matrix of the instance.
 
         The duration of the operation with ``job_id`` i and ``position_in_job``
@@ -305,7 +305,7 @@ class JobShopInstance:
         return [[operation.duration for operation in job] for job in self.jobs]
 
     @functools.cached_property
-    def machines_matrix(self) -> Union[List[List[List[int]]], List[List[int]]]:
+    def machines_matrix(self) -> list[list[list[int]]] | list[list[int]]:
         """Returns the machines matrix of the instance.
 
         If the instance is flexible (i.e., if any operation has more than one
@@ -371,25 +371,25 @@ class JobShopInstance:
         machines_matrix = self.machines_matrix
         if self.is_flexible:
             # False positive from mypy, the type of machines_matrix is
-            # List[List[List[int]]] here
+            # list[list[list[int]]] here
             return self._fill_matrix_with_nans_3d(
                 machines_matrix  # type: ignore[arg-type]
             )
 
         # False positive from mypy, the type of machines_matrix is
-        # List[List[int]] here
+        # list[list[int]] here
         return self._fill_matrix_with_nans_2d(
             machines_matrix  # type: ignore[arg-type]
         )
 
     @functools.cached_property
-    def operations_by_machine(self) -> List[List[Operation]]:
+    def operations_by_machine(self) -> list[list[Operation]]:
         """Returns a list of lists of operations.
 
         The i-th list contains the operations that can be processed in the
         machine with id i.
         """
-        operations_by_machine: List[List[Operation]] = [
+        operations_by_machine: list[list[Operation]] = [
             [] for _ in range(self.num_machines)
         ]
         for job in self.jobs:
@@ -409,7 +409,7 @@ class JobShopInstance:
         )
 
     @functools.cached_property
-    def max_duration_per_job(self) -> List[float]:
+    def max_duration_per_job(self) -> list[float]:
         """Returns the maximum duration of each job in the instance.
 
         The maximum duration of the job with id i is stored in the i-th
@@ -420,7 +420,7 @@ class JobShopInstance:
         return [max(op.duration for op in job) for job in self.jobs]
 
     @functools.cached_property
-    def max_duration_per_machine(self) -> List[int]:
+    def max_duration_per_machine(self) -> list[int]:
         """Returns the maximum duration of each machine in the instance.
 
         The maximum duration of the machine with id i is stored in the i-th
@@ -439,7 +439,7 @@ class JobShopInstance:
         return max_duration_per_machine
 
     @functools.cached_property
-    def job_durations(self) -> List[int]:
+    def job_durations(self) -> list[int]:
         """Returns a list with the duration of each job in the instance.
 
         The duration of a job is the sum of the durations of its operations.
@@ -450,7 +450,7 @@ class JobShopInstance:
         return [sum(op.duration for op in job) for job in self.jobs]
 
     @functools.cached_property
-    def machine_loads(self) -> List[int]:
+    def machine_loads(self) -> list[int]:
         """Returns the total machine load of each machine in the instance.
 
         The total machine load of a machine is the sum of the durations of the
@@ -474,7 +474,7 @@ class JobShopInstance:
 
     @staticmethod
     def _fill_matrix_with_nans_2d(
-        matrix: List[List[int]],
+        matrix: list[list[int]],
     ) -> NDArray[np.float32]:
         """Fills a matrix with ``np.nan`` values.
 
@@ -496,7 +496,7 @@ class JobShopInstance:
 
     @staticmethod
     def _fill_matrix_with_nans_3d(
-        matrix: List[List[List[int]]],
+        matrix: list[list[list[int]]],
     ) -> NDArray[np.float32]:
         """Fills a 3D matrix with ``np.nan`` values.
 

{job_shop_lib-1.0.1 → job_shop_lib-1.0.3}/job_shop_lib/_operation.py

@@ -2,8 +2,6 @@
 
 from __future__ import annotations
 
-from typing import Union, List
-
 from job_shop_lib.exceptions import ValidationError
 
 
@@ -61,8 +59,8 @@ class Operation:
         ),
     }
 
-    def __init__(self, machines: Union[int, List[int]], duration: int):
-        self.machines: List[int] = (
+    def __init__(self, machines: int | list[int], duration: int):
+        self.machines: list[int] = (
             [machines] if isinstance(machines, int) else machines
         )
         self.duration: int = duration

{job_shop_lib-1.0.1 → job_shop_lib-1.0.3}/job_shop_lib/_schedule.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Any, List, Union, Dict, Optional
+from typing import Any
 from collections import deque
 
 from job_shop_lib import ScheduledOperation, JobShopInstance
@@ -55,7 +55,7 @@ class Schedule:
     def __init__(
         self,
         instance: JobShopInstance,
-        schedule: Optional[List[List[ScheduledOperation]]] = None,
+        schedule: list[list[ScheduledOperation]] | None = None,
         **metadata: Any,
     ):
         if schedule is None:
@@ -65,19 +65,19 @@ class Schedule:
 
         self.instance: JobShopInstance = instance
         self._schedule = schedule
-        self.metadata: Dict[str, Any] = metadata
+        self.metadata: dict[str, Any] = metadata
 
     def __repr__(self) -> str:
         return str(self.schedule)
 
     @property
-    def schedule(self) -> List[List[ScheduledOperation]]:
+    def schedule(self) -> list[list[ScheduledOperation]]:
         """A list of lists of :class:`ScheduledOperation` objects. Each list
         represents the order of operations on a machine."""
         return self._schedule
 
     @schedule.setter
-    def schedule(self, new_schedule: List[List[ScheduledOperation]]):
+    def schedule(self, new_schedule: list[list[ScheduledOperation]]):
         Schedule.check_schedule(new_schedule)
         self._schedule = new_schedule
 
@@ -103,7 +103,7 @@ class Schedule:
                 - **"metadata"**: A dictionary with additional information
                   about the schedule.
         """
-        job_sequences: List[List[int]] = []
+        job_sequences: list[list[int]] = []
         for machine_schedule in self.schedule:
             job_sequences.append(
                 [operation.job_id for operation in machine_schedule]
@@ -117,9 +117,9 @@ class Schedule:
 
     @staticmethod
     def from_dict(
-        instance: Union[Dict[str, Any], JobShopInstance],
-        job_sequences: List[List[int]],
-        metadata: Optional[Dict[str, Any]] = None,
+        instance: dict[str, Any] | JobShopInstance,
+        job_sequences: list[list[int]],
+        metadata: dict[str, Any] | None = None,
     ) -> Schedule:
         """Creates a schedule from a dictionary representation."""
         if isinstance(instance, dict):
@@ -131,7 +131,7 @@ class Schedule:
     @staticmethod
     def from_job_sequences(
         instance: JobShopInstance,
-        job_sequences: List[List[int]],
+        job_sequences: list[list[int]],
     ) -> Schedule:
         """Creates an active schedule from a list of job sequences.
 
@@ -240,7 +240,7 @@ class Schedule:
         return previous_operation.end_time <= scheduled_operation.start_time
 
     @staticmethod
-    def check_schedule(schedule: List[List[ScheduledOperation]]):
+    def check_schedule(schedule: list[list[ScheduledOperation]]):
         """Checks if a schedule is valid and raises a
         :class:`~exceptions.ValidationError` if it is not.
 

{job_shop_lib-1.0.1 → job_shop_lib-1.0.3}/job_shop_lib/benchmarking/__init__.py

@@ -1,6 +1,7 @@
 """Contains functions to load benchmark instances.
 
 .. autosummary::
+    :nosignatures:
 
     load_all_benchmark_instances
     load_benchmark_instance

{job_shop_lib-1.0.1 → job_shop_lib-1.0.3}/job_shop_lib/benchmarking/_load_benchmark.py

@@ -1,6 +1,6 @@
 """Contains functions to load benchmark instances from a JSON file."""
 
-from typing import Any, Dict
+from typing import Any
 
 import functools
 import json
@@ -10,7 +10,7 @@ from job_shop_lib import JobShopInstance
 
 
 @functools.cache
-def load_all_benchmark_instances() -> Dict[str, JobShopInstance]:
+def load_all_benchmark_instances() -> dict[str, JobShopInstance]:
     """Loads all benchmark instances available.
 
     Returns:
@@ -48,7 +48,7 @@ def load_benchmark_instance(name: str) -> JobShopInstance:
 
 
 @functools.cache
-def load_benchmark_json() -> Dict[str, Dict[str, Any]]:
+def load_benchmark_json() -> dict[str, dict[str, Any]]:
     """Loads the raw JSON file containing the benchmark instances.
 
     Results are cached to avoid reading the file multiple times.

{job_shop_lib-1.0.1 → job_shop_lib-1.0.3}/job_shop_lib/constraint_programming/_ortools_solver.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Any, Dict, List, Tuple
+from typing import Any
 import time
 
 from ortools.sat.python import cp_model
@@ -62,7 +62,7 @@ class ORToolsSolver(BaseSolver):
         self._makespan: cp_model.IntVar | None = None
         self.model = cp_model.CpModel()
         self.solver = cp_model.CpSolver()
-        self._operations_start: Dict[Operation, Tuple[IntVar, IntVar]] = {}
+        self._operations_start: dict[Operation, tuple[IntVar, IntVar]] = {}
 
     def __call__(self, instance: JobShopInstance) -> Schedule:
         """Equivalent to calling the :meth:`~ORToolsSolver.solve` method.
@@ -152,15 +152,15 @@ class ORToolsSolver(BaseSolver):
         self._set_objective(instance)
 
     def _create_schedule(
-        self, instance: JobShopInstance, metadata: Dict[str, Any]
+        self, instance: JobShopInstance, metadata: dict[str, Any]
     ) -> Schedule:
         """Creates a Schedule object from the solution."""
-        operations_start: Dict[Operation, int] = {
+        operations_start: dict[Operation, int] = {
             operation: self.solver.Value(start_var)
             for operation, (start_var, _) in self._operations_start.items()
         }
 
-        unsorted_schedule: List[List[ScheduledOperation]] = [
+        unsorted_schedule: list[list[ScheduledOperation]] = [
             [] for _ in range(instance.num_machines)
         ]
         for operation, start_time in operations_start.items():
@@ -235,7 +235,7 @@ class ORToolsSolver(BaseSolver):
         each machine."""
 
         # Create interval variables for each operation on each machine
-        machines_operations: List[List[Tuple[Tuple[IntVar, IntVar], int]]] = [
+        machines_operations: list[list[tuple[tuple[IntVar, IntVar], int]]] = [
             [] for _ in range(instance.num_machines)
         ]
         for job in instance.jobs:

{job_shop_lib-1.0.1 → job_shop_lib-1.0.3}/job_shop_lib/dispatching/__init__.py

@@ -9,13 +9,15 @@ Problem step-by-step.
     HistoryObserver
     UnscheduledOperationsObserver
     OptimalOperationsObserver
-    ReadyOperationsFilter
     DispatcherObserverConfig
+    ReadyOperationsFilter
+    ReadyOperationsFilterType
+    ready_operations_filter_factory
     filter_dominated_operations
     filter_non_immediate_machines
+    filter_non_idle_machines
+    filter_non_immediate_operations
     create_composite_operation_filter
-    ReadyOperationsFilterType
-    ready_operations_filter_factory
 
 Dispatching refers to the decision-making process of selecting which job
 should be processed next on a particular machine when that machine becomes
@@ -45,17 +47,17 @@ from ._factories import (
 
 __all__ = [
     "Dispatcher",
-    "filter_dominated_operations",
-    "filter_non_immediate_machines",
-    "create_composite_operation_filter",
-    "ReadyOperationsFilterType",
-    "ready_operations_filter_factory",
     "DispatcherObserver",
     "HistoryObserver",
-    "DispatcherObserverConfig",
     "UnscheduledOperationsObserver",
+    "OptimalOperationsObserver",
+    "DispatcherObserverConfig",
     "ReadyOperationsFilter",
+    "ReadyOperationsFilterType",
+    "ready_operations_filter_factory",
+    "filter_dominated_operations",
+    "filter_non_immediate_machines",
     "filter_non_idle_machines",
     "filter_non_immediate_operations",
-    "OptimalOperationsObserver",
+    "create_composite_operation_filter",
 ]