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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 1.0.1
+Version: 1.0.2
 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.2}/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.2}/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.2"
 
 __all__ = [
     "Operation",

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

@@ -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:
 

{job_shop_lib-1.0.1 → job_shop_lib-1.0.2}/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.2}/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",
 ]

{job_shop_lib-1.0.1 → job_shop_lib-1.0.2}/job_shop_lib/dispatching/feature_observers/_composite_feature_observer.py

@@ -5,7 +5,7 @@ from collections.abc import Sequence
 from typing import List, Dict, Union, Optional, Type
 # The Self type can be imported directly from Python’s typing module in
 # version 3.11 and beyond. We use the typing_extensions module to support
-# python >=3.8
+# python >=3.10
 from typing_extensions import Self
 import numpy as np
 from numpy.typing import NDArray

{job_shop_lib-1.0.1 → job_shop_lib-1.0.2}/job_shop_lib/dispatching/rules/__init__.py

@@ -3,17 +3,19 @@
 Main objects:
 
 .. autosummary::
+    :nosignatures:
 
     DispatchingRuleSolver
-    dispatching_rule_factory
     DispatchingRuleType
-    MachineChooserType
     dispatching_rule_factory
+    MachineChooserType
     machine_chooser_factory
+    MachineChooser
 
 Dispatching rules:
 
 .. autosummary::
+    :nosignatures:
 
     shortest_processing_time_rule
     first_come_first_served_rule
@@ -27,6 +29,7 @@ Dispatching rules:
 Dispatching rule scorers:
 
 .. autosummary::
+    :nosignatures:
 
     shortest_processing_time_score
     first_come_first_served_score
@@ -65,6 +68,11 @@ from ._dispatching_rule_solver import DispatchingRuleSolver
 
 
 __all__ = [
+    "DispatchingRuleSolver",
+    "DispatchingRuleType",
+    "dispatching_rule_factory",
+    "MachineChooserType",
+    "machine_chooser_factory",
     "shortest_processing_time_rule",
     "first_come_first_served_rule",
     "most_work_remaining_rule",
@@ -72,16 +80,11 @@ __all__ = [
     "random_operation_rule",
     "score_based_rule",
     "score_based_rule_with_tie_breaker",
+    "observer_based_most_work_remaining_rule",
     "shortest_processing_time_score",
     "first_come_first_served_score",
     "MostWorkRemainingScorer",
     "most_operations_remaining_score",
     "random_score",
-    "dispatching_rule_factory",
-    "DispatchingRuleType",
-    "MachineChooserType",
-    "machine_chooser_factory",
     "MachineChooser",
-    "DispatchingRuleSolver",
-    "observer_based_most_work_remaining_rule",
 ]

{job_shop_lib-1.0.1 → job_shop_lib-1.0.2}/job_shop_lib/generation/__init__.py

@@ -1,4 +1,15 @@
-"""Package for generating job shop instances."""
+"""Package for generating job shop instances.
+
+.. autosummary::
+    :nosignatures:
+
+    InstanceGenerator
+    GeneralInstanceGenerator
+    generate_duration_matrix
+    generate_machine_matrix_with_recirculation
+    generate_machine_matrix_without_recirculation
+
+"""
 
 from job_shop_lib.generation._utils import (
     generate_duration_matrix,

{job_shop_lib-1.0.1 → job_shop_lib-1.0.2}/job_shop_lib/graphs/__init__.py

@@ -2,15 +2,47 @@
 
 The main classes and functions available in this package are:
 
+Main objects:
+
 .. autosummary::
+    :nosignatures:
+
     JobShopGraph
     Node
     NodeType
+    EdgeType
+    NODE_ATTR
+
+Build functions:
+
+.. autosummary::
+    :nosignatures:
+
     build_disjunctive_graph
-    build_solved_disjunctive_graph
     build_resource_task_graph
     build_complete_resource_task_graph
     build_resource_task_graph_with_jobs
+    build_solved_disjunctive_graph
+
+Add functions:
+
+.. autosummary::
+    :nosignatures:
+
+    add_disjunctive_edges
+    add_conjunctive_edges
+    add_source_sink_nodes
+    add_source_sink_edges
+    add_same_job_operations_edges
+    add_machine_nodes
+    add_operation_machine_edges
+    add_machine_machine_edges
+    add_job_nodes
+    add_operation_job_edges
+    add_global_node
+    add_machine_global_edges
+    add_job_global_edges
+    add_job_job_edges
 
 """
 
@@ -43,19 +75,20 @@ from job_shop_lib.graphs._build_resource_task_graphs import (
 
 
 __all__ = [
-    "EdgeType",
-    "NodeType",
-    "Node",
     "JobShopGraph",
+    "Node",
+    "NodeType",
+    "EdgeType",
     "NODE_ATTR",
     "build_disjunctive_graph",
+    "build_resource_task_graph",
+    "build_complete_resource_task_graph",
+    "build_resource_task_graph_with_jobs",
+    "build_solved_disjunctive_graph",
     "add_disjunctive_edges",
     "add_conjunctive_edges",
     "add_source_sink_nodes",
     "add_source_sink_edges",
-    "build_resource_task_graph",
-    "build_complete_resource_task_graph",
-    "build_resource_task_graph_with_jobs",
     "add_same_job_operations_edges",
     "add_machine_nodes",
     "add_operation_machine_edges",
@@ -65,6 +98,5 @@ __all__ = [
     "add_global_node",
     "add_machine_global_edges",
     "add_job_global_edges",
-    "build_solved_disjunctive_graph",
     "add_job_job_edges",
 ]

{job_shop_lib-1.0.1 → job_shop_lib-1.0.2}/job_shop_lib/graphs/graph_updaters/__init__.py

@@ -4,6 +4,7 @@ job shop scheduling problem.
 Currently, the following classes and utilities are available:
 
 .. autosummary::
+    :nosignatures:
 
     GraphUpdater
     ResidualGraphUpdater
@@ -20,7 +21,7 @@ from ._disjunctive_graph_updater import DisjunctiveGraphUpdater
 
 __all__ = [
     "GraphUpdater",
-    "remove_completed_operations",
     "ResidualGraphUpdater",
     "DisjunctiveGraphUpdater",
+    "remove_completed_operations",
 ]

{job_shop_lib-1.0.1 → job_shop_lib-1.0.2}/job_shop_lib/reinforcement_learning/__init__.py

@@ -1,12 +1,16 @@
 """Contains reinforcement learning components.
 
 
+
 .. autosummary::
+    :nosignatures:
 
     SingleJobShopGraphEnv
     MultiJobShopGraphEnv
     ObservationDict
     ObservationSpaceKey
+    ResourceTaskGraphObservation
+    ResourceTaskGraphObservationDict
     RewardObserver
     MakespanReward
     IdleTimeReward
@@ -15,8 +19,6 @@
     create_edge_type_dict
     map_values
     get_optimal_actions
-    ResourceTaskGraphObservation
-    ResourceTaskGraphObservationDict
 
 """
 
@@ -51,18 +53,18 @@ from ._resource_task_graph_observation import (
 
 
 __all__ = [
+    "SingleJobShopGraphEnv",
+    "MultiJobShopGraphEnv",
+    "ObservationDict",
     "ObservationSpaceKey",
+    "ResourceTaskGraphObservation",
+    "ResourceTaskGraphObservationDict",
     "RewardObserver",
     "MakespanReward",
     "IdleTimeReward",
-    "SingleJobShopGraphEnv",
     "RenderConfig",
-    "ObservationDict",
     "add_padding",
-    "MultiJobShopGraphEnv",
     "create_edge_type_dict",
-    "ResourceTaskGraphObservation",
     "map_values",
-    "ResourceTaskGraphObservationDict",
     "get_optimal_actions",
 ]

{job_shop_lib-1.0.1 → job_shop_lib-1.0.2}/job_shop_lib/visualization/gantt/__init__.py

@@ -1,15 +1,19 @@
 """Contains functions and classes for visualizing job shop scheduling problems.
 
 .. autosummary::
+    :nosignatures:
 
     plot_gantt_chart
-    get_partial_gantt_chart_plotter
-    PartialGanttChartPlotter
     create_gantt_chart_video
     create_gantt_chart_gif
+    create_gantt_chart_frames
+    get_partial_gantt_chart_plotter
+    create_gif_from_frames
+    create_video_from_frames
     GanttChartCreator
     GifConfig
     VideoConfig
+    PartialGanttChartPlotter
     PartialGanttChartPlotterConfig
 
 """
@@ -41,8 +45,8 @@ __all__ = [
     "create_gif_from_frames",
     "create_video_from_frames",
     "GanttChartCreator",
-    "PartialGanttChartPlotterConfig",
     "GifConfig",
     "VideoConfig",
     "PartialGanttChartPlotter",
+    "PartialGanttChartPlotterConfig",
 ]

{job_shop_lib-1.0.1 → job_shop_lib-1.0.2}/job_shop_lib/visualization/graphs/__init__.py

@@ -1,6 +1,7 @@
 """Contains functions and classes for visualizing job shop scheduling problems.
 
 .. autosummary::
+    :nosignatures:
 
     plot_disjunctive_graph
     plot_resource_task_graph

{job_shop_lib-1.0.1 → job_shop_lib-1.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "job-shop-lib"
-version = "1.0.1"
+version = "1.0.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"
@@ -43,6 +43,8 @@ ipykernel = "^6.29.2"
 nbconvert = "^7.16.0"
 pandas = "^2.2.1"
 
+[tool.poetry.group.docs]
+optional = true
 
 [tool.poetry.group.docs.dependencies]
 sphinx = "^7.3.7"
@@ -54,15 +56,6 @@ pandoc = "^2.3"
 pygments = "^2.18.0"
 ipython = "^8.31.0"
 
-[tool.poetry.group.claude.dependencies]
-anthropic = "^0.31.2"
-python-dotenv = "^1.0.1"
-tavily-python = "^0.3.5"
-pillow = "^10.4.0"
-rich = "^13.7.1"
-aiohttp = "^3.9.5"
-prompt-toolkit = "^3.0.47"
-
 [tool.poetry.extras]
 pygraphviz = ["pygraphviz"]