job-shop-lib 1.0.0a4__tar.gz → 1.0.0b1__tar.gz

{job_shop_lib-1.0.0a4 → job_shop_lib-1.0.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 1.0.0a4
+Version: 1.0.0b1
 Summary: An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)
 License: MIT
 Author: Pabloo22
@@ -17,7 +17,7 @@ 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,<2.0.0)
-Requires-Dist: ortools (>=9.9,<9.10)
+Requires-Dist: ortools (>=9.9,<10.0)
 Requires-Dist: pyarrow (>=15.0.0,<16.0.0)
 Requires-Dist: pygraphviz (>=1.12,<2.0) ; extra == "pygraphviz"
 Description-Content-Type: text/markdown
@@ -36,7 +36,7 @@ Description-Content-Type: text/markdown
 
 </div>
 
-JobShopLib is a Python package for creating, solving, and visualizing Job Shop Scheduling Problems (JSSP).
+JobShopLib is a Python package for creating, solving, and visualizing job shop scheduling problems (JSSP).
 
 It follows a modular design, allowing users to easily extend the library with new solvers, dispatching rules, visualization functions, etc.
 
@@ -60,10 +60,10 @@ See [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcoww
 Version 1.0.0 is currently in alpha stage and can be installed with:
 
 ```bash
-pip install job-shop-lib==1.0.0a4
+pip install job-shop-lib==1.0.0b1
 ```
 
-Although this version is not stable and may contain breaking changes in subsequent releases, it is recommended to install it to access the new reinforcement learning environments and familiarize yourself with new changes (see the [latest pull requests](https://github.com/Pabloo22/job_shop_lib/pulls?q=is%3Apr+is%3Aclosed)). This version is the first one with a [documentation page](https://job-shop-lib.readthedocs.io/en/latest/).
+Although this version is not stable and may contain breaking changes in subsequent releases, it is recommended to install it to access the new reinforcement learning environments and familiarize yourself with new changes (see the [latest pull requests](https://github.com/Pabloo22/job_shop_lib/pulls?q=is%3Apr+is%3Aclosed)). There is a [documentation page](https://job-shop-lib.readthedocs.io/en/latest/) for versions 1.0.0a3 and onward.
 
 <!-- end installation -->
 
@@ -71,25 +71,25 @@ Although this version is not stable and may contain breaking changes in subseque
 
 ## Key Features :star:
 
-- **Data Structures**: Easily create, manage, and manipulate job shop instances and solutions with user-friendly data structures. See [Getting Started](docs/source/examples/00-Getting-Started.ipynb) and [How Solutions are Represented](docs/source/examples/01-How-Solutions-are-Represented.ipynb).
+- **Data Structures**: Easily create, manage, and manipulate job shop instances and solutions with user-friendly data structures. See [Getting Started](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/00-Getting-Started.ipynb) and [How Solutions are Represented](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/01-How-Solutions-are-Represented.ipynb).
 
-- **Benchmark Instances**: Load well-known benchmark instances directly from the library without manual downloading. See [Load Benchmark Instances](docs/source/examples/05-Load-Benchmark-Instances.ipynb).
+- **Benchmark Instances**: Load well-known benchmark instances directly from the library without manual downloading. See [Load Benchmark Instances](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/05-Load-Benchmark-Instances.ipynb).
 
 - **Random Instance Generation**: Create random instances with customizable sizes and properties or augment existing ones. See [`generation`](job_shop_lib/generation) package.
 
 - **Multiple Solvers**:
-  - **Constraint Programming Solver**: OR-Tools' CP-SAT solver. See [Solving the Problem](docs/source/examples/02-Solving-the-Problem.ipynb).
+  - **Constraint Programming Solver**: OR-Tools' CP-SAT solver. See [Solving the Problem](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/02-Solving-the-Problem.ipynb).
 
-  - **Dispatching Rule Solvers**: Use any of the available dispatching rules or create custom ones. See [Dispatching Rules](docs/source/examples/03-Dispatching-Rules.ipynb).
+  - **Dispatching Rule Solvers**: Use any of the available dispatching rules or create custom ones. See [Dispatching Rules](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/03-Dispatching-Rules.ipynb).
 
-- **Gantt Charts**: Visualize final schedules and how are they created iteratively by dispatching rule solvers or sequences of scheduling decisions with GIFs or videos. See [Save Gif](docs/source/examples/06-Save-Gif.ipynb).
+- **Gantt Charts**: Visualize final schedules and how are they created iteratively by dispatching rule solvers or sequences of scheduling decisions with GIFs or videos. See [Save Gif](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/06-Save-Gif.ipynb).
 
 - **Graph Representations**:
-  - **Disjunctive Graphs**: Represent and visualize instances as disjunctive graphs. See [Disjunctive Graph](docs/source/examples/04-Disjunctive-Graph.ipynb).
-  - **Agent-Task Graphs**: Encode instances as agent-task graphs (introduced in [ScheduleNet paper](https://arxiv.org/abs/2106.03051)). See [Agent-Task Graph](docs/source/examples/07-Agent-Task-Graph.ipynb).
+  - **Disjunctive Graphs**: Represent and visualize instances as disjunctive graphs. See [Disjunctive Graph](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/04-Disjunctive-Graph.ipynb).
+  - **Agent-Task Graphs**: Encode instances as agent-task graphs (introduced in [ScheduleNet paper](https://arxiv.org/abs/2106.03051)). See [Agent-Task Graph](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/07-Agent-Task-Graph.ipynb).
   - Build your own custom graphs with the `JobShopGraph` class.
 
-- **Gymnasium Environments**: Two environments for solving the problem with Graph Neural Networks (GNNs) or any other method, and Reinforcement Learning (RL). See [SingleJobShopGraphEnv](docs/source/examples/09-SingleJobShopGraphEnv.ipynb) and [MultiJobShopGraphEnv](examples/10-MultiJobShopGraphEnv.ipynb).
+- **Gymnasium Environments**: Two environments for solving the problem with graph neural networks (GNNs) or any other method, and reinforcement learning (RL). See [SingleJobShopGraphEnv](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/09-SingleJobShopGraphEnv.ipynb) and [MultiJobShopGraphEnv](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/10-MultiJobShopGraphEnv.ipynb).
 
 <!-- end key features -->
 
@@ -245,7 +245,7 @@ The dashed red line represents the current time step, which is computed as the e
 
 ### Representing Instances as Graphs
 
-One of the main purposes of this library is to provide an easy way to encode instances as graphs. This can be very useful, not only for visualization purposes but also for developing Graph Neural Network-based algorithms.
+One of the main purposes of this library is to provide an easy way to encode instances as graphs. This can be very useful, not only for visualization purposes but also for developing graph neural network-based algorithms.
 
 A graph is represented by the `JobShopGraph` class, which internally stores a `networkx.DiGraph` object.
 
@@ -253,7 +253,7 @@ A graph is represented by the `JobShopGraph` class, which internally stores a `n
 
 The disjunctive graph is created by first adding nodes representing each operation in the jobs, along with two special nodes: a source $S$ and a sink $T$. Each operation node is linked to the next operation in its job sequence by **conjunctive edges**, forming a path from the source to the sink. These edges represent the order in which operations of a single job must be performed.
 
-Additionally, the graph includes **disjunctive edges** between operations that use the same machine but belong to different jobs. These edges are bidirectional, indicating that either of the connected operations can be performed first. The disjunctive edges thus represent the scheduling choices available: the order in which operations sharing a machine can be processed. Solving the Job Shop Scheduling problem involves choosing a direction for each disjunctive edge such that the overall processing time is minimized.
+Additionally, the graph includes **disjunctive edges** between operations that use the same machine but belong to different jobs. These edges are bidirectional, indicating that either of the connected operations can be performed first. The disjunctive edges thus represent the scheduling choices available: the order in which operations sharing a machine can be processed. Solving the job shop scheduling problem involves choosing a direction for each disjunctive edge such that the overall processing time is minimized.
 
 ```python
 from job_shop_lib.visualization import plot_disjunctive_graph
@@ -295,9 +295,9 @@ Other attributes include:
 - `nodes_by_machine`: A nested list mapping each machine to its associated operation nodes, aiding in machine-specific analysis.
 - `nodes_by_job`: Similar to `nodes_by_machine`, but maps jobs to their operation nodes, useful for job-specific traversal.
 
-#### Agent-Task Graph
+#### Resource-Task Graph
 
-Introduced in the paper "ScheduleNet: Learn to solve multi-agent scheduling problems with reinforcement learning" by [Park et al. (2021)](https://arxiv.org/abs/2106.03051), the Agent-Task Graph is a graph that represents the scheduling problem as a multi-agent reinforcement learning problem.
+Introduced in the paper "ScheduleNet: Learn to solve multi-agent scheduling problems with reinforcement learning" by [Park et al. (2021)](https://arxiv.org/abs/2106.03051), the resource-task graph (orginally named "agent-task graph") is a graph that represents the scheduling problem as a multi-agent reinforcement learning problem.
 
 In contrast to the disjunctive graph, instead of connecting operations
 that share the same resources directly by disjunctive edges, operation
@@ -308,25 +308,27 @@ from the same job are connected by non-directed edges too.
 
 ```python
 from job_shop_lib.graphs import (
-    build_complete_agent_task_graph,
-    build_agent_task_graph_with_jobs,
-    build_agent_task_graph,
+    build_complete_resource_task_graph,
+    build_resource_task_graph_with_jobs,
+    build_resource_task_graph,
 )
-from job_shop_lib.visualization import plot_agent_task_graph
+from job_shop_lib.visualization import plot_resource_task_graph
 
-complete_agent_task_graph = build_complete_agent_task_graph(instance)
+complete_resource_task_graph = build_complete_resource_task_graph(instance)
 
-fig = plot_agent_task_graph(complete_agent_task_graph)
+fig = plot_resource_task_graph(complete_agent_task_graph)
 plt.show()
 ```
 
 <div align="center">
-<img src="docs/source/images/agent_task_graph.png" width="300">
+<img src="docs/source/examples/output/agent_task_graph.png" width="300">
 </div>
 <br>
 
 ----
 
+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.
 
 ## Installation for development

{job_shop_lib-1.0.0a4 → job_shop_lib-1.0.0b1}/README.md

@@ -12,7 +12,7 @@
 
 </div>
 
-JobShopLib is a Python package for creating, solving, and visualizing Job Shop Scheduling Problems (JSSP).
+JobShopLib is a Python package for creating, solving, and visualizing job shop scheduling problems (JSSP).
 
 It follows a modular design, allowing users to easily extend the library with new solvers, dispatching rules, visualization functions, etc.
 
@@ -36,10 +36,10 @@ See [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcoww
 Version 1.0.0 is currently in alpha stage and can be installed with:
 
 ```bash
-pip install job-shop-lib==1.0.0a4
+pip install job-shop-lib==1.0.0b1
 ```
 
-Although this version is not stable and may contain breaking changes in subsequent releases, it is recommended to install it to access the new reinforcement learning environments and familiarize yourself with new changes (see the [latest pull requests](https://github.com/Pabloo22/job_shop_lib/pulls?q=is%3Apr+is%3Aclosed)). This version is the first one with a [documentation page](https://job-shop-lib.readthedocs.io/en/latest/).
+Although this version is not stable and may contain breaking changes in subsequent releases, it is recommended to install it to access the new reinforcement learning environments and familiarize yourself with new changes (see the [latest pull requests](https://github.com/Pabloo22/job_shop_lib/pulls?q=is%3Apr+is%3Aclosed)). There is a [documentation page](https://job-shop-lib.readthedocs.io/en/latest/) for versions 1.0.0a3 and onward.
 
 <!-- end installation -->
 
@@ -47,25 +47,25 @@ Although this version is not stable and may contain breaking changes in subseque
 
 ## Key Features :star:
 
-- **Data Structures**: Easily create, manage, and manipulate job shop instances and solutions with user-friendly data structures. See [Getting Started](docs/source/examples/00-Getting-Started.ipynb) and [How Solutions are Represented](docs/source/examples/01-How-Solutions-are-Represented.ipynb).
+- **Data Structures**: Easily create, manage, and manipulate job shop instances and solutions with user-friendly data structures. See [Getting Started](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/00-Getting-Started.ipynb) and [How Solutions are Represented](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/01-How-Solutions-are-Represented.ipynb).
 
-- **Benchmark Instances**: Load well-known benchmark instances directly from the library without manual downloading. See [Load Benchmark Instances](docs/source/examples/05-Load-Benchmark-Instances.ipynb).
+- **Benchmark Instances**: Load well-known benchmark instances directly from the library without manual downloading. See [Load Benchmark Instances](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/05-Load-Benchmark-Instances.ipynb).
 
 - **Random Instance Generation**: Create random instances with customizable sizes and properties or augment existing ones. See [`generation`](job_shop_lib/generation) package.
 
 - **Multiple Solvers**:
-  - **Constraint Programming Solver**: OR-Tools' CP-SAT solver. See [Solving the Problem](docs/source/examples/02-Solving-the-Problem.ipynb).
+  - **Constraint Programming Solver**: OR-Tools' CP-SAT solver. See [Solving the Problem](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/02-Solving-the-Problem.ipynb).
 
-  - **Dispatching Rule Solvers**: Use any of the available dispatching rules or create custom ones. See [Dispatching Rules](docs/source/examples/03-Dispatching-Rules.ipynb).
+  - **Dispatching Rule Solvers**: Use any of the available dispatching rules or create custom ones. See [Dispatching Rules](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/03-Dispatching-Rules.ipynb).
 
-- **Gantt Charts**: Visualize final schedules and how are they created iteratively by dispatching rule solvers or sequences of scheduling decisions with GIFs or videos. See [Save Gif](docs/source/examples/06-Save-Gif.ipynb).
+- **Gantt Charts**: Visualize final schedules and how are they created iteratively by dispatching rule solvers or sequences of scheduling decisions with GIFs or videos. See [Save Gif](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/06-Save-Gif.ipynb).
 
 - **Graph Representations**:
-  - **Disjunctive Graphs**: Represent and visualize instances as disjunctive graphs. See [Disjunctive Graph](docs/source/examples/04-Disjunctive-Graph.ipynb).
-  - **Agent-Task Graphs**: Encode instances as agent-task graphs (introduced in [ScheduleNet paper](https://arxiv.org/abs/2106.03051)). See [Agent-Task Graph](docs/source/examples/07-Agent-Task-Graph.ipynb).
+  - **Disjunctive Graphs**: Represent and visualize instances as disjunctive graphs. See [Disjunctive Graph](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/04-Disjunctive-Graph.ipynb).
+  - **Agent-Task Graphs**: Encode instances as agent-task graphs (introduced in [ScheduleNet paper](https://arxiv.org/abs/2106.03051)). See [Agent-Task Graph](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/07-Agent-Task-Graph.ipynb).
   - Build your own custom graphs with the `JobShopGraph` class.
 
-- **Gymnasium Environments**: Two environments for solving the problem with Graph Neural Networks (GNNs) or any other method, and Reinforcement Learning (RL). See [SingleJobShopGraphEnv](docs/source/examples/09-SingleJobShopGraphEnv.ipynb) and [MultiJobShopGraphEnv](examples/10-MultiJobShopGraphEnv.ipynb).
+- **Gymnasium Environments**: Two environments for solving the problem with graph neural networks (GNNs) or any other method, and reinforcement learning (RL). See [SingleJobShopGraphEnv](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/09-SingleJobShopGraphEnv.ipynb) and [MultiJobShopGraphEnv](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/10-MultiJobShopGraphEnv.ipynb).
 
 <!-- end key features -->
 
@@ -221,7 +221,7 @@ The dashed red line represents the current time step, which is computed as the e
 
 ### Representing Instances as Graphs
 
-One of the main purposes of this library is to provide an easy way to encode instances as graphs. This can be very useful, not only for visualization purposes but also for developing Graph Neural Network-based algorithms.
+One of the main purposes of this library is to provide an easy way to encode instances as graphs. This can be very useful, not only for visualization purposes but also for developing graph neural network-based algorithms.
 
 A graph is represented by the `JobShopGraph` class, which internally stores a `networkx.DiGraph` object.
 
@@ -229,7 +229,7 @@ A graph is represented by the `JobShopGraph` class, which internally stores a `n
 
 The disjunctive graph is created by first adding nodes representing each operation in the jobs, along with two special nodes: a source $S$ and a sink $T$. Each operation node is linked to the next operation in its job sequence by **conjunctive edges**, forming a path from the source to the sink. These edges represent the order in which operations of a single job must be performed.
 
-Additionally, the graph includes **disjunctive edges** between operations that use the same machine but belong to different jobs. These edges are bidirectional, indicating that either of the connected operations can be performed first. The disjunctive edges thus represent the scheduling choices available: the order in which operations sharing a machine can be processed. Solving the Job Shop Scheduling problem involves choosing a direction for each disjunctive edge such that the overall processing time is minimized.
+Additionally, the graph includes **disjunctive edges** between operations that use the same machine but belong to different jobs. These edges are bidirectional, indicating that either of the connected operations can be performed first. The disjunctive edges thus represent the scheduling choices available: the order in which operations sharing a machine can be processed. Solving the job shop scheduling problem involves choosing a direction for each disjunctive edge such that the overall processing time is minimized.
 
 ```python
 from job_shop_lib.visualization import plot_disjunctive_graph
@@ -271,9 +271,9 @@ Other attributes include:
 - `nodes_by_machine`: A nested list mapping each machine to its associated operation nodes, aiding in machine-specific analysis.
 - `nodes_by_job`: Similar to `nodes_by_machine`, but maps jobs to their operation nodes, useful for job-specific traversal.
 
-#### Agent-Task Graph
+#### Resource-Task Graph
 
-Introduced in the paper "ScheduleNet: Learn to solve multi-agent scheduling problems with reinforcement learning" by [Park et al. (2021)](https://arxiv.org/abs/2106.03051), the Agent-Task Graph is a graph that represents the scheduling problem as a multi-agent reinforcement learning problem.
+Introduced in the paper "ScheduleNet: Learn to solve multi-agent scheduling problems with reinforcement learning" by [Park et al. (2021)](https://arxiv.org/abs/2106.03051), the resource-task graph (orginally named "agent-task graph") is a graph that represents the scheduling problem as a multi-agent reinforcement learning problem.
 
 In contrast to the disjunctive graph, instead of connecting operations
 that share the same resources directly by disjunctive edges, operation
@@ -284,25 +284,27 @@ from the same job are connected by non-directed edges too.
 
 ```python
 from job_shop_lib.graphs import (
-    build_complete_agent_task_graph,
-    build_agent_task_graph_with_jobs,
-    build_agent_task_graph,
+    build_complete_resource_task_graph,
+    build_resource_task_graph_with_jobs,
+    build_resource_task_graph,
 )
-from job_shop_lib.visualization import plot_agent_task_graph
+from job_shop_lib.visualization import plot_resource_task_graph
 
-complete_agent_task_graph = build_complete_agent_task_graph(instance)
+complete_resource_task_graph = build_complete_resource_task_graph(instance)
 
-fig = plot_agent_task_graph(complete_agent_task_graph)
+fig = plot_resource_task_graph(complete_agent_task_graph)
 plt.show()
 ```
 
 <div align="center">
-<img src="docs/source/images/agent_task_graph.png" width="300">
+<img src="docs/source/examples/output/agent_task_graph.png" width="300">
 </div>
 <br>
 
 ----
 
+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.
 
 ## Installation for development

{job_shop_lib-1.0.0a4 → job_shop_lib-1.0.0b1}/job_shop_lib/__init__.py

@@ -19,6 +19,8 @@ from job_shop_lib._schedule import Schedule
 from job_shop_lib._base_solver import BaseSolver, Solver
 
 
+__version__ = "1.0.0-b.1"
+
 __all__ = [
     "Operation",
     "JobShopInstance",
@@ -26,4 +28,5 @@ __all__ = [
     "Schedule",
     "Solver",
     "BaseSolver",
+    "__version__",
 ]

{job_shop_lib-1.0.0a4 → job_shop_lib-1.0.0b1}/job_shop_lib/_job_shop_instance.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import os
 import functools
-from typing import Any
+from typing import Any, List, Union, Dict
 
 import numpy as np
 from numpy.typing import NDArray
@@ -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.
+            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: os.PathLike | str | bytes,
+        file_path: Union[os.PathLike, str, bytes],
         encoding: str = "utf-8",
         comment_symbol: str = "#",
-        name: str | None = None,
+        name: Union[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) -> list[list[list[int]]] | list[list[int]]:
+    def machines_matrix(self) -> Union[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
@@ -342,7 +342,7 @@ class JobShopInstance:
             >>> jobs = [[Operation(0, 2), Operation(1, 3)], [Operation(0, 4)]]
             >>> instance = JobShopInstance(jobs)
             >>> instance.durations_matrix_array
-            array([[ 2.,  2.],
+            array([[ 2.,  3.],
                    [ 4., nan]], dtype=float32)
         """
         duration_matrix = self.durations_matrix
@@ -358,8 +358,7 @@ class JobShopInstance:
 
         Example:
             >>> jobs = [
-            ...     [Operation(machines=[0, 1], 2), Operation(machines=1, 3)],
-            ...     [Operation(machines=0, 6)],
+            ...     [Operation([0, 1], 2), Operation(1, 3)], [Operation(0, 6)]
             ... ]
             >>> instance = JobShopInstance(jobs)
             >>> instance.machines_matrix_array
@@ -372,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:
@@ -410,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
@@ -421,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
@@ -440,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.
@@ -451,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
@@ -475,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.
 
@@ -497,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.
 
@@ -523,3 +522,9 @@ class JobShopInstance:
             for j, inner_row in enumerate(row):
                 squared_matrix[i, j, : len(inner_row)] = inner_row
         return squared_matrix
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()

{job_shop_lib-1.0.0a4 → job_shop_lib-1.0.0b1}/job_shop_lib/_operation.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing import Union, List
+
 from job_shop_lib.exceptions import UninitializedAttributeError
 
 
@@ -59,8 +61,8 @@ class Operation:
         ),
     }
 
-    def __init__(self, machines: int | list[int], duration: int):
-        self.machines: list[int] = (
+    def __init__(self, machines: Union[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.0a4 → job_shop_lib-1.0.0b1}/job_shop_lib/_schedule.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Any
+from typing import Any, List, Union, Dict, Optional
 from collections import deque
 
 from job_shop_lib import ScheduledOperation, JobShopInstance
@@ -55,7 +55,7 @@ class Schedule:
     def __init__(
         self,
         instance: JobShopInstance,
-        schedule: list[list[ScheduledOperation]] | None = None,
+        schedule: Optional[List[List[ScheduledOperation]]] = 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: dict[str, Any] | JobShopInstance,
-        job_sequences: list[list[int]],
-        metadata: dict[str, Any] | None = None,
+        instance: Union[Dict[str, Any], JobShopInstance],
+        job_sequences: List[List[int]],
+        metadata: Optional[Dict[str, Any]] = 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.0a4 → job_shop_lib-1.0.0b1}/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
+from typing import Any, Dict
 
 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.