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

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-a.5"
+
 __all__ = [
     "Operation",
     "JobShopInstance",
@@ -26,4 +28,5 @@ __all__ = [
     "Schedule",
     "Solver",
     "BaseSolver",
+    "__version__",
 ]

job_shop_lib/_job_shop_instance.py

@@ -54,8 +54,8 @@ class JobShopInstance:
         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]):

job_shop_lib/constraint_programming/_ortools_solver.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Any
 import time
 
 from ortools.sat.python import cp_model
@@ -151,7 +152,7 @@ class ORToolsSolver(BaseSolver):
         self._set_objective(instance)
 
     def _create_schedule(
-        self, instance: JobShopInstance, metadata: dict[str, object]
+        self, instance: JobShopInstance, metadata: dict[str, Any]
     ) -> Schedule:
         """Creates a Schedule object from the solution."""
         operations_start: dict[Operation, int] = {

job_shop_lib/dispatching/_dispatcher.py

@@ -153,6 +153,36 @@ class Dispatcher:
     responsible for scheduling the operations on the machines and keeping
     track of the next available time for each machine and job.
 
+    The core method of the class are:
+
+    .. autosummary::
+
+        dispatch
+        reset
+
+    It also provides methods to query the state of the schedule and the
+    operations:
+
+    .. autosummary::
+
+        current_time
+        available_operations
+        available_machines
+        available_jobs
+        unscheduled_operations
+        scheduled_operations
+        ongoing_operations
+        completed_operations
+        uncompleted_operations
+        is_scheduled
+        is_ongoing
+        next_operation
+        earliest_start_time
+        remaining_duration
+
+    The above methods which do not take any arguments are cached to improve
+    performance. After each scheduling operation, the cache is cleared.
+
     Args:
         instance:
             The instance of the job shop problem to be solved.
@@ -189,11 +219,11 @@ class Dispatcher:
         self.instance = instance
         self.schedule = Schedule(self.instance)
         self.ready_operations_filter = ready_operations_filter
+        self.subscribers: list[DispatcherObserver] = []
 
         self._machine_next_available_time = [0] * self.instance.num_machines
         self._job_next_operation_index = [0] * self.instance.num_jobs
         self._job_next_available_time = [0] * self.instance.num_jobs
-        self.subscribers: list[DispatcherObserver] = []
         self._cache: dict[str, Any] = {}
 
     def __str__(self) -> str:
@@ -236,7 +266,9 @@ class Dispatcher:
         for subscriber in self.subscribers:
             subscriber.reset()
 
-    def dispatch(self, operation: Operation, machine_id: int) -> None:
+    def dispatch(
+        self, operation: Operation, machine_id: int | None = None
+    ) -> None:
         """Schedules the given operation on the given machine.
 
         The start time of the operation is computed based on the next
@@ -249,15 +281,21 @@ class Dispatcher:
                 The operation to be scheduled.
             machine_id:
                 The id of the machine on which the operation is to be
-                scheduled.
+                scheduled. If ``None``, the :class:`~job_shop_lib.Operation`'s
+                :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
+                machines in its list and no ``machine_id`` is provided.
         """
 
         if not self.is_operation_ready(operation):
             raise ValidationError("Operation is not ready to be scheduled.")
 
+        if machine_id is None:
+            machine_id = operation.machine_id
+
         start_time = self.start_time(operation, machine_id)
 
         scheduled_operation = ScheduledOperation(

job_shop_lib/dispatching/_factories.py

@@ -38,11 +38,11 @@ def create_composite_operation_filter(
         ReadyOperationsFilter | str | ReadyOperationsFilterType
     ],
 ) -> ReadyOperationsFilter:
-    """Creates and returns a composite filter based on the specified list of
-    filters.
+    """Creates and returns a :class:`ReadyOperationsFilter` function by
+    combining multiple filter strategies.
 
-    The composite filter function filters operations based on the specified
-    list of filter strategies.
+    The composite filter function applies multiple filter strategies
+    iteratively in the order they are specified in the list.
 
     Args:
         ready_operations_filters:

{job_shop_lib-1.0.0a4.dist-info → job_shop_lib-1.0.0a5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 1.0.0a4
+Version: 1.0.0a5
 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
@@ -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.0a5
 ```
 
-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 -->
 

{job_shop_lib-1.0.0a4.dist-info → job_shop_lib-1.0.0a5.dist-info}/RECORD

@@ -1,6 +1,6 @@
-job_shop_lib/__init__.py,sha256=Ci5ipn-zciO88C5aX5Wx-UN8iBTbpde3dSSg02ZcfwM,597
+job_shop_lib/__init__.py,sha256=727ReBd86kZgmAYA8lkYhDRaAnqJ6iH6uBP-zIRbjw4,643
 job_shop_lib/_base_solver.py,sha256=p17XmtufNc9Y481cqZUT45pEkUmmW1HWG53dfhIBJH8,1363
-job_shop_lib/_job_shop_instance.py,sha256=hc_rYHv0RRvcBmQLtXcSTZJ_YQxKBfhoSEcTNvf8Oio,18319
+job_shop_lib/_job_shop_instance.py,sha256=OoKkZRQK6kbk0zgiXc-0mFk8t7aFpWK2Cah-vmI60AY,18321
 job_shop_lib/_operation.py,sha256=6YgAuqFQgvoGIYTkdsBh-b8mVlc0i9AIw8cqmiTXeHE,3809
 job_shop_lib/_schedule.py,sha256=QQ7orbpd00pTjJvsh8bNuRSEFJLst8B8GaCSB8JPXTY,11251
 job_shop_lib/_scheduled_operation.py,sha256=krjGn47VwsC7bXUTqlUq8Y-DpiSE9q2z8bqwgJVpAZo,2697
@@ -8,11 +8,11 @@ job_shop_lib/benchmarking/__init__.py,sha256=BYCrJUNr_uk2c0xIbDt07OnUMhQx8Dudkuk
 job_shop_lib/benchmarking/_load_benchmark.py,sha256=-cgyx0Kn6uAc3KdGFSQb6eUVQjQggmpVKOH9qusNkXI,2930
 job_shop_lib/benchmarking/benchmark_instances.json,sha256=F9EvyzFwVxiKAN6rQTsrMhsKstmyUmroyWduM7a00KQ,464841
 job_shop_lib/constraint_programming/__init__.py,sha256=kKQRUxxS_nVFUdXGnf4bQOD9mqrXxZZWElS753A4YiA,454
-job_shop_lib/constraint_programming/_ortools_solver.py,sha256=gRoImEBUa8_io-TzbSS-3f0CJ7UwacU5Lrz0bsDqibo,10462
+job_shop_lib/constraint_programming/_ortools_solver.py,sha256=oMPeA2VHoYX1ZvmygQ8kYew40ITLAQATmM4OhgVFuXM,10482
 job_shop_lib/dispatching/__init__.py,sha256=2VQYWNSyuDx3zzrDPCEzs5VJd2AIJvF7vA7LwK5z2V4,1648
-job_shop_lib/dispatching/_dispatcher.py,sha256=5B2KA0-nHLeFsZ1KxZxwLJ2muknzQVhwqUV4pFlo6bw,21218
+job_shop_lib/dispatching/_dispatcher.py,sha256=uy4_EHdhwhGLWc1zv1AtY9FApP-70AdjCnLa3_q2nOQ,22316
 job_shop_lib/dispatching/_dispatcher_observer_config.py,sha256=034m83TsZXAb89nPxGRZm--0KSaGA9tJnr-7aYQs6tU,2479
-job_shop_lib/dispatching/_factories.py,sha256=njS5yUd5K74ceAUFcqofUlx0efMvfJB6twdZdrCqhfE,4596
+job_shop_lib/dispatching/_factories.py,sha256=D9m_tHUqQe-aGc50X_5HSm27nELwm4VyVEg6zUudkyg,4643
 job_shop_lib/dispatching/_history_observer.py,sha256=Vl8rQaxekUeEB-AyNxyC3c76zQakeh-rdri2iDnZvXw,610
 job_shop_lib/dispatching/_ready_operation_filters.py,sha256=Mywt57h8Nlj6XrptWakVt9n1Tq4jsneZFQEgjLMxJgw,5731
 job_shop_lib/dispatching/_unscheduled_operations_observer.py,sha256=LNEzqOWqEf6fvtkQrDmDWFEhCfA75OgEtzdomzbxYII,2683
@@ -60,7 +60,7 @@ job_shop_lib/visualization/_gantt_chart_video_and_gif_creation.py,sha256=aPy7y0o
 job_shop_lib/visualization/_plot_agent_task_graph.py,sha256=AaBTD_S34WjrsZnL_iMAplR_f67RahZi7x58SOvp-q0,8834
 job_shop_lib/visualization/_plot_disjunctive_graph.py,sha256=Vo3c2oHQ8YkLbwrDr76zh4yzCuQk-gkVeyWN-7Zj71o,14279
 job_shop_lib/visualization/_plot_gantt_chart.py,sha256=1WCJ5Gjl3dwA-w4Jn9suIg-ZGR28yYUAy8Jp-IiyvfI,6842
-job_shop_lib-1.0.0a4.dist-info/LICENSE,sha256=9mggivMGd5taAu3xbmBway-VQZMBzurBGHofFopvUsQ,1069
-job_shop_lib-1.0.0a4.dist-info/METADATA,sha256=14EToNDww1XMWqiMJguxDG6ER1ApNGnowyjBR5CC8vY,15656
-job_shop_lib-1.0.0a4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-job_shop_lib-1.0.0a4.dist-info/RECORD,,
+job_shop_lib-1.0.0a5.dist-info/LICENSE,sha256=9mggivMGd5taAu3xbmBway-VQZMBzurBGHofFopvUsQ,1069
+job_shop_lib-1.0.0a5.dist-info/METADATA,sha256=R-7tM_SWNJV6JoTtDh_FlO6SbD-fXQt36Ro0KZAzLKk,16184
+job_shop_lib-1.0.0a5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+job_shop_lib-1.0.0a5.dist-info/RECORD,,