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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 1.0.0b1
+Version: 1.0.0b2
 Summary: An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)
 License: MIT
 Author: Pabloo22
@@ -57,10 +57,10 @@ 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! 
 
 
-Version 1.0.0 is currently in alpha stage and can be installed with:
+Version 1.0.0 is currently in beta stage and can be installed with:
 
 ```bash
-pip install job-shop-lib==1.0.0b1
+pip install job-shop-lib==1.0.0b2
 ```
 
 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.
@@ -89,7 +89,11 @@ Although this version is not stable and may contain breaking changes in subseque
   - **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.
 
+<<<<<<< HEAD
 - **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).
+=======
+- **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).
+>>>>>>> 031bdf3 ([Docs] Update links in README to point to the correct GitHub URLs for tutorials and examples)
 
 <!-- end key features -->
 

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

@@ -33,10 +33,10 @@ 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! 
 
 
-Version 1.0.0 is currently in alpha stage and can be installed with:
+Version 1.0.0 is currently in beta stage and can be installed with:
 
 ```bash
-pip install job-shop-lib==1.0.0b1
+pip install job-shop-lib==1.0.0b2
 ```
 
 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.
@@ -65,7 +65,11 @@ Although this version is not stable and may contain breaking changes in subseque
   - **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.
 
+<<<<<<< HEAD
 - **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).
+=======
+- **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).
+>>>>>>> 031bdf3 ([Docs] Update links in README to point to the correct GitHub URLs for tutorials and examples)
 
 <!-- end key features -->
 

{job_shop_lib-1.0.0b1 → job_shop_lib-1.0.0b2}/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.0-b.1"
+__version__ = "1.0.0-b.2"
 
 __all__ = [
     "Operation",

{job_shop_lib-1.0.0b1 → job_shop_lib-1.0.0b2}/job_shop_lib/dispatching/__init__.py

@@ -8,6 +8,7 @@ Problem step-by-step.
     DispatcherObserver
     HistoryObserver
     UnscheduledOperationsObserver
+    OptimalOperationsObserver
     ReadyOperationsFilter
     DispatcherObserverConfig
     filter_dominated_operations
@@ -25,9 +26,8 @@ from ._dispatcher import Dispatcher, DispatcherObserver
 from ._history_observer import (
     HistoryObserver,
 )
-from ._unscheduled_operations_observer import (
-    UnscheduledOperationsObserver,
-)
+from ._unscheduled_operations_observer import UnscheduledOperationsObserver
+from ._optimal_operations_observer import OptimalOperationsObserver
 from ._ready_operation_filters import (
     filter_dominated_operations,
     filter_non_immediate_machines,
@@ -57,4 +57,5 @@ __all__ = [
     "ReadyOperationsFilter",
     "filter_non_idle_machines",
     "filter_non_immediate_operations",
+    "OptimalOperationsObserver",
 ]

job_shop_lib-1.0.0b2/job_shop_lib/dispatching/_optimal_operations_observer.py

@@ -0,0 +1,115 @@
+"""Home of the `OptimalOperationsObserver` class."""
+
+from typing import List, Set, Dict
+from job_shop_lib.dispatching import DispatcherObserver, Dispatcher
+from job_shop_lib import Schedule, Operation, ScheduledOperation
+from job_shop_lib.exceptions import ValidationError
+
+
+class OptimalOperationsObserver(DispatcherObserver):
+    """Observer that identifies which available operations are optimal based on
+    a reference schedule.
+
+    This observer compares the available operations at each step with a
+    reference schedule to determine which operations would lead to the optimal
+    solution. It can be used for training purposes or to analyze decision
+    making in dispatching algorithms.
+
+    Attributes:
+        optimal_operations: Set of operations that are considered optimal
+            based on the reference schedule.
+        reference_schedule: The reference schedule used to determine optimal
+            operations.
+        _operation_to_scheduled: Dictionary mapping operations to their
+            scheduled versions in the reference schedule.
+
+    Args:
+        dispatcher: The dispatcher instance to observe.
+        reference_schedule: A complete schedule that represents the optimal
+            or reference solution.
+        subscribe: If True, automatically subscribes to the dispatcher.
+
+    Raises:
+        ValidationError: If the reference schedule is incomplete or if it
+            doesn't match the dispatcher's instance.
+    """
+
+    _is_singleton = False
+
+    def __init__(
+        self,
+        dispatcher: Dispatcher,
+        reference_schedule: Schedule,
+        *,
+        subscribe: bool = True,
+    ):
+        super().__init__(dispatcher, subscribe=subscribe)
+
+        if not reference_schedule.is_complete():
+            raise ValidationError("Reference schedule must be complete.")
+
+        if reference_schedule.instance != dispatcher.instance:
+            raise ValidationError(
+                "Reference schedule instance does not match dispatcher "
+                "instance."
+            )
+
+        self.reference_schedule = reference_schedule
+        self.optimal_available: Set[Operation] = set()
+        self._operation_to_scheduled: Dict[Operation, ScheduledOperation] = {}
+        self._machine_next_operation_index: List[int] = [0] * len(
+            reference_schedule.schedule
+        )
+
+        self._build_operation_mapping()
+        self._update_optimal_operations()
+
+    def _build_operation_mapping(self) -> None:
+        """Builds a mapping from operations to their scheduled versions in
+        the reference schedule."""
+        for machine_schedule in self.reference_schedule.schedule:
+            for scheduled_op in machine_schedule:
+                self._operation_to_scheduled[scheduled_op.operation] = (
+                    scheduled_op
+                )
+
+    def _update_optimal_operations(self) -> None:
+        """Updates the set of optimal operations based on current state.
+
+        An operation is considered optimal if it is the next unscheduled
+        operation in its machine's sequence according to the reference
+        schedule.
+        """
+        self.optimal_available.clear()
+        available_operations = self.dispatcher.available_operations()
+
+        if not available_operations:
+            return
+
+        for operation in available_operations:
+            scheduled_op = self._operation_to_scheduled[operation]
+            machine_index = scheduled_op.machine_id
+            next_index = self._machine_next_operation_index[machine_index]
+
+            if (
+                scheduled_op
+                == self.reference_schedule.schedule[machine_index][next_index]
+            ):
+                self.optimal_available.add(operation)
+
+    def update(self, scheduled_operation: ScheduledOperation) -> None:
+        """Updates the optimal operations after an operation is scheduled.
+
+        Args:
+            scheduled_operation: The operation that was just scheduled.
+        """
+        self._machine_next_operation_index[scheduled_operation.machine_id] += 1
+        self._update_optimal_operations()
+
+    def reset(self) -> None:
+        """Resets the observer to its initial state."""
+        self._machine_next_operation_index = [0] * len(
+            self.dispatcher.schedule.schedule
+        )
+        self.optimal_available.clear()
+        self._update_optimal_operations()

{job_shop_lib-1.0.0b1 → job_shop_lib-1.0.0b2}/job_shop_lib/dispatching/rules/__init__.py

@@ -1,4 +1,40 @@
-"""Contains the dispatching rules for the job shop scheduling problem."""
+"""Contains the dispatching rules for the job shop scheduling problem.
+
+Main objects:
+
+.. autosummary::
+
+    DispatchingRuleSolver
+    dispatching_rule_factory
+    DispatchingRuleType
+    MachineChooserType
+    dispatching_rule_factory
+    machine_chooser_factory
+
+Dispatching rules:
+
+.. autosummary::
+
+    shortest_processing_time_rule
+    first_come_first_served_rule
+    most_work_remaining_rule
+    most_operations_remaining_rule
+    random_operation_rule
+    score_based_rule
+    score_based_rule_with_tie_breaker
+    observer_based_most_work_remaining_rule
+
+Dispatching rule scorers:
+
+.. autosummary::
+
+    shortest_processing_time_score
+    first_come_first_served_score
+    MostWorkRemainingScorer
+    most_operations_remaining_score
+    random_score
+
+"""
 
 from ._dispatching_rules_functions import (
     shortest_processing_time_rule,

{job_shop_lib-1.0.0b1 → job_shop_lib-1.0.0b2}/job_shop_lib/dispatching/rules/_dispatching_rule_solver.py

@@ -30,14 +30,14 @@ class DispatchingRuleSolver(BaseSolver):
             Used to choose the machine where the operation will be dispatched
             to. It is only used if the operation can be dispatched to multiple
             machines.
-        pruning_function:
-            The pruning function to use. It is used to initialize the
+        ready_operations_filter:
+            The ready operations filter to use. It is used to initialize the
             dispatcher object internally when calling the solve method.
 
     Args:
         dispatching_rule:
             The dispatching rule to use. It can be a string with the name
-            of the dispatching rule, a class`DispatchingRuleType` enum member,
+            of the dispatching rule, a :class:`DispatchingRuleType` member,
             or a callable that takes a dispatcher and returns the operation to
             be dispatched next.
         machine_chooser:
@@ -110,8 +110,30 @@ class DispatchingRuleSolver(BaseSolver):
         instance: JobShopInstance,
         dispatcher: Optional[Dispatcher] = None,
     ) -> Schedule:
-        """Returns a schedule for the given job shop instance using the
-        dispatching rule algorithm."""
+        """Solves the instance using the dispatching rule and machine chooser
+        algorithms.
+
+        Args:
+            instance:
+                The job shop instance to be solved.
+            dispatcher:
+                The dispatcher object that will be used to dispatch the
+                operations. If not provided, a new dispatcher will be created
+                using the ready operations filter provided in the constructor.
+
+        Returns:
+            The schedule obtained after solving the instance.
+
+        .. tip::
+            Another way to use the solver is by calling it as a function. This
+            will call the ``solve`` method internally and will add metadata to
+            the schedule. For example:
+
+            .. code-block:: python
+
+                solver = DispatchingRuleSolver()
+                schedule = solver(instance)
+        """
         if dispatcher is None:
             dispatcher = Dispatcher(
                 instance, ready_operations_filter=self.ready_operations_filter

{job_shop_lib-1.0.0b1 → job_shop_lib-1.0.0b2}/job_shop_lib/visualization/graphs/__init__.py

@@ -3,7 +3,7 @@
 .. autosummary::
 
     plot_disjunctive_graph
-    plot_heterogeneous_graph
+    plot_resource_task_graph
     three_columns_layout
     duration_labeler
     color_nodes_by_machine

{job_shop_lib-1.0.0b1 → job_shop_lib-1.0.0b2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "job-shop-lib"
-version = "1.0.0-beta.1"
+version = "1.0.0-beta.2"
 description = "An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)"
 authors = ["Pabloo22 <pablete.arino@gmail.com>"]
 license = "MIT"