job-shop-lib 0.1.2__tar.gz → 0.2.0__tar.gz

{job_shop_lib-0.1.2 → job_shop_lib-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 0.1.2
+Version: 0.2.0
 Summary: An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)
 License: MIT
 Author: Pabloo22
@@ -16,7 +16,7 @@ Requires-Dist: imageio (>=2,<3)
 Requires-Dist: matplotlib (>=3,<4)
 Requires-Dist: networkx (>=3,<4)
 Requires-Dist: ortools (>=9,<10)
-Requires-Dist: pyarrow (>=14.0.0,<15.0.0)
+Requires-Dist: pyarrow (>=15.0.0,<16.0.0)
 Requires-Dist: pygraphviz (>=1.12,<2.0) ; extra == "pygraphviz"
 Description-Content-Type: text/markdown
 
@@ -33,13 +33,21 @@ Description-Content-Type: text/markdown
 
 </div>
 
+An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP) with a special focus on graph representations.
 
+It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools.
 
-An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP) with a special focus on graph representations.
+See the [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
+
+## Installation
 
-It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools:
+You can install the library from PyPI:
+
+```bash
+pip install job-shop-lib
+```
 
-## Quick Start
+## Quick Start :rocket:
 
 ### Create a Job Shop Instance
 
@@ -79,40 +87,22 @@ manually. The instances are stored in [benchmark_instances.json](job_shop_lib/be
 
 The contributions to this benchmark dataset are as follows:
 
-- `abz5-9`: This subset, comprising five instances, was introduced by Adams et
-    al. (1988).
+- `abz5-9`: by Adams et al. (1988).
 
-- `ft06`, `ft10`, `ft20`: These three instances are attributed to the work of
-    Fisher and Thompson, as detailed in their 1963 work.
+- `ft06`, `ft10`, `ft20`: by Fisher and Thompson (1963).
 
-- `la01-40`: A collection of forty instances, this group was contributed by
-    Lawrence, as referenced in his 1984 report.
+- `la01-40`: by Lawrence (1984)
 
-- `orb01-10`: Ten instances in this category were provided by Applegate and
-    Cook, as seen in their 1991 study.
+- `orb01-10`: by Applegate and Cook (1991).
 
-- `swb01-20`: This segment, encompassing twenty instances, was contributed by
-    Storer et al., as per their 1992 article.
+- `swb01-20`: by Storer et al. (1992).
 
-- `yn1-4`: Yamada and Nakano are credited with the addition of four instances
-    in this group, as found in their 1992 paper.
+- `yn1-4`: by Yamada and Nakano (1992).
 
-- `ta01-80`: The largest contribution, consisting of eighty instances, was
-    made by Taillard, as documented in his 1993 paper.
+- `ta01-80`: by Taillard (1993).
 
 The metadata from these instances has been updated using data from:
-
-Thomas Weise. jsspInstancesAndResults. Accessed in January 2024.
-Available at: https://github.com/thomasWeise/jsspInstancesAndResults
-
-It includes the following information:
-  - "optimum" (`int` | `None`): The optimal makespan for the instance.
-  - "lower_bound" (`int`): The best lower bound known for the makespan. If
-      optimality is known, it is equal to the optimum.
-  - "upper_bound" (`int`): The best upper bound known for the makespan. If
-      optimality is known, it is equal to the optimum.
-  - "reference" (`str`): The paper or source where the instance was first
-      introduced.
+https://github.com/thomasWeise/jsspInstancesAndResults
 
 ```python
 >>> ft06.metadata
@@ -124,7 +114,7 @@ It includes the following information:
 
 ### Generate a Random Instance
 
-You can also generate a random instance with the `InstanceGenerator` class.
+You can also generate a random instance with the `BasicGenerator` class.
 
 ```python
 from job_shop_lib.generators import BasicGenerator
@@ -138,7 +128,7 @@ random_instance = generator.generate()
 This class can also work as an iterator to generate multiple instances:
 
 ```python
-generator = InstanceGenerator(iteration_limit=100, seed=42)
+generator = BasicGenerator(iteration_limit=100, seed=42)
 instances = []
 for instance in generator:
     instances.append(instance)
@@ -182,7 +172,7 @@ We can visualize the solution with a `DispatchingRuleSolver` as a gif:
 
 ```python
 from job_shop_lib.visualization import create_gif, get_plot_function
-from job_shop_lib.solvers import DispatchingRuleSolver, DispatchingRule
+from job_shop_lib.dispatching import DispatchingRuleSolver, DispatchingRule
 
 plt.style.use("ggplot")
 
@@ -227,6 +217,9 @@ plt.show()
 ![Example Disjunctive Graph](images/example_disjunctive_graph.png)
 
 
+> [!WARNING]
+> This plot function requires having the optional dependency [PyGraphViz](https://pygraphviz.github.io/) installed.
+
 The `JobShopGraph` class provides easy access to the nodes, for example, to get all the nodes of a specific type:
 
 ```python
@@ -288,13 +281,9 @@ plt.show()
 
 For more details, check the [examples](examples) folder.
 
-## Installation
-
-In the future, the library will be available on PyPI. For now, you can install it from the source code.
-
-### For development
+## Installation for development
 
-#### With Poetry
+### With Poetry
 
 1. Clone the repository.
 
@@ -315,7 +304,7 @@ or equivalently:
 make poetry_install_all 
 ```
 
-#### With PyPI
+### With PyPI
 
 If you don't want to use Poetry, you can install the library directly from the source code:
 

{job_shop_lib-0.1.2 → job_shop_lib-0.2.0}/README.md

@@ -11,13 +11,21 @@
 
 </div>
 
+An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP) with a special focus on graph representations.
 
+It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools.
 
-An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP) with a special focus on graph representations.
+See the [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
+
+## Installation
 
-It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools:
+You can install the library from PyPI:
+
+```bash
+pip install job-shop-lib
+```
 
-## Quick Start
+## Quick Start :rocket:
 
 ### Create a Job Shop Instance
 
@@ -57,40 +65,22 @@ manually. The instances are stored in [benchmark_instances.json](job_shop_lib/be
 
 The contributions to this benchmark dataset are as follows:
 
-- `abz5-9`: This subset, comprising five instances, was introduced by Adams et
-    al. (1988).
+- `abz5-9`: by Adams et al. (1988).
 
-- `ft06`, `ft10`, `ft20`: These three instances are attributed to the work of
-    Fisher and Thompson, as detailed in their 1963 work.
+- `ft06`, `ft10`, `ft20`: by Fisher and Thompson (1963).
 
-- `la01-40`: A collection of forty instances, this group was contributed by
-    Lawrence, as referenced in his 1984 report.
+- `la01-40`: by Lawrence (1984)
 
-- `orb01-10`: Ten instances in this category were provided by Applegate and
-    Cook, as seen in their 1991 study.
+- `orb01-10`: by Applegate and Cook (1991).
 
-- `swb01-20`: This segment, encompassing twenty instances, was contributed by
-    Storer et al., as per their 1992 article.
+- `swb01-20`: by Storer et al. (1992).
 
-- `yn1-4`: Yamada and Nakano are credited with the addition of four instances
-    in this group, as found in their 1992 paper.
+- `yn1-4`: by Yamada and Nakano (1992).
 
-- `ta01-80`: The largest contribution, consisting of eighty instances, was
-    made by Taillard, as documented in his 1993 paper.
+- `ta01-80`: by Taillard (1993).
 
 The metadata from these instances has been updated using data from:
-
-Thomas Weise. jsspInstancesAndResults. Accessed in January 2024.
-Available at: https://github.com/thomasWeise/jsspInstancesAndResults
-
-It includes the following information:
-  - "optimum" (`int` | `None`): The optimal makespan for the instance.
-  - "lower_bound" (`int`): The best lower bound known for the makespan. If
-      optimality is known, it is equal to the optimum.
-  - "upper_bound" (`int`): The best upper bound known for the makespan. If
-      optimality is known, it is equal to the optimum.
-  - "reference" (`str`): The paper or source where the instance was first
-      introduced.
+https://github.com/thomasWeise/jsspInstancesAndResults
 
 ```python
 >>> ft06.metadata
@@ -102,7 +92,7 @@ It includes the following information:
 
 ### Generate a Random Instance
 
-You can also generate a random instance with the `InstanceGenerator` class.
+You can also generate a random instance with the `BasicGenerator` class.
 
 ```python
 from job_shop_lib.generators import BasicGenerator
@@ -116,7 +106,7 @@ random_instance = generator.generate()
 This class can also work as an iterator to generate multiple instances:
 
 ```python
-generator = InstanceGenerator(iteration_limit=100, seed=42)
+generator = BasicGenerator(iteration_limit=100, seed=42)
 instances = []
 for instance in generator:
     instances.append(instance)
@@ -160,7 +150,7 @@ We can visualize the solution with a `DispatchingRuleSolver` as a gif:
 
 ```python
 from job_shop_lib.visualization import create_gif, get_plot_function
-from job_shop_lib.solvers import DispatchingRuleSolver, DispatchingRule
+from job_shop_lib.dispatching import DispatchingRuleSolver, DispatchingRule
 
 plt.style.use("ggplot")
 
@@ -205,6 +195,9 @@ plt.show()
 ![Example Disjunctive Graph](images/example_disjunctive_graph.png)
 
 
+> [!WARNING]
+> This plot function requires having the optional dependency [PyGraphViz](https://pygraphviz.github.io/) installed.
+
 The `JobShopGraph` class provides easy access to the nodes, for example, to get all the nodes of a specific type:
 
 ```python
@@ -266,13 +259,9 @@ plt.show()
 
 For more details, check the [examples](examples) folder.
 
-## Installation
-
-In the future, the library will be available on PyPI. For now, you can install it from the source code.
-
-### For development
+## Installation for development
 
-#### With Poetry
+### With Poetry
 
 1. Clone the repository.
 
@@ -293,7 +282,7 @@ or equivalently:
 make poetry_install_all 
 ```
 
-#### With PyPI
+### With PyPI
 
 If you don't want to use Poetry, you can install the library directly from the source code:
 

job_shop_lib-0.2.0/job_shop_lib/generators/transformations.py

@@ -0,0 +1,164 @@
+"""Classes for generating transformed JobShopInstance objects."""
+
+import abc
+import copy
+import random
+
+from job_shop_lib import JobShopInstance, Operation
+
+
+class Transformation(abc.ABC):
+    """Base class for transformations applied to JobShopInstance objects."""
+
+    def __init__(self, suffix: str = ""):
+        self.suffix = suffix
+        self.counter = 0
+
+    @abc.abstractmethod
+    def apply(self, instance: JobShopInstance) -> JobShopInstance:
+        """Applies the transformation to a given JobShopInstance.
+
+        Args:
+            instance: The JobShopInstance to transform.
+
+        Returns:
+            A new JobShopInstance with the transformation applied.
+        """
+
+    def __call__(self, instance: JobShopInstance) -> JobShopInstance:
+        instance = self.apply(instance)
+        suffix = f"{self.suffix}_id={self.counter}"
+        instance.name += suffix
+        self.counter += 1
+        return instance
+
+
+# pylint: disable=too-few-public-methods
+class RemoveMachines(Transformation):
+    """Removes operations associated with randomly selected machines until
+    there are exactly num_machines machines left."""
+
+    def __init__(self, num_machines: int, suffix: str | None = None):
+        if suffix is None:
+            suffix = f"_machines={num_machines}"
+        super().__init__(suffix=suffix)
+        self.num_machines = num_machines
+
+    def apply(self, instance: JobShopInstance) -> JobShopInstance:
+        if instance.num_machines <= self.num_machines:
+            return instance  # No need to remove machines
+
+        # Select machine indices to keep
+        machines_to_keep = set(
+            random.sample(range(instance.num_machines), self.num_machines)
+        )
+
+        # Re-index machines
+        machine_reindex_map = {
+            old_id: new_id
+            for new_id, old_id in enumerate(sorted(machines_to_keep))
+        }
+
+        new_jobs = []
+        for job in instance.jobs:
+            # Keep operations whose machine_id is in machines_to_keep and
+            # re-index them
+            new_jobs.append(
+                [
+                    Operation(machine_reindex_map[op.machine_id], op.duration)
+                    for op in job
+                    if op.machine_id in machines_to_keep
+                ]
+            )
+
+        return JobShopInstance(new_jobs, instance.name)
+
+
+# pylint: disable=too-few-public-methods
+class AddDurationNoise(Transformation):
+    """Adds uniform integer noise to operation durations."""
+
+    def __init__(
+        self,
+        min_duration: int = 1,
+        max_duration: int = 100,
+        noise_level: int = 10,
+        suffix: str | None = None,
+    ):
+        if suffix is None:
+            suffix = f"_noise={noise_level}"
+        super().__init__(suffix=suffix)
+        self.min_duration = min_duration
+        self.max_duration = max_duration
+        self.noise_level = noise_level
+
+    def apply(self, instance: JobShopInstance) -> JobShopInstance:
+        new_jobs = []
+        for job in instance.jobs:
+            new_job = []
+            for op in job:
+                noise = random.randint(-self.noise_level, self.noise_level)
+                new_duration = max(
+                    self.min_duration,
+                    min(self.max_duration, op.duration + noise),
+                )
+
+                new_job.append(Operation(op.machine_id, new_duration))
+            new_jobs.append(new_job)
+
+        return JobShopInstance(new_jobs, instance.name)
+
+
+class RemoveJobs(Transformation):
+    """Removes jobs randomly until the number of jobs is within a specified
+    range."""
+
+    def __init__(
+        self,
+        min_jobs: int,
+        max_jobs: int,
+        target_jobs: int | None = None,
+        suffix: str | None = None,
+    ):
+        """
+        Args:
+            min_jobs: The minimum number of jobs to remain in the instance.
+            max_jobs: The maximum number of jobs to remain in the instance.
+            target_jobs: If specified, the number of jobs to remain in the
+                instance. Overrides min_jobs and max_jobs.
+        """
+        if suffix is None:
+            suffix = f"_jobs={min_jobs}-{max_jobs}"
+        super().__init__(suffix=suffix)
+        self.min_jobs = min_jobs
+        self.max_jobs = max_jobs
+        self.target_jobs = target_jobs
+
+    def apply(self, instance: JobShopInstance) -> JobShopInstance:
+        if self.target_jobs is None:
+            target_jobs = random.randint(self.min_jobs, self.max_jobs)
+        else:
+            target_jobs = self.target_jobs
+        new_jobs = copy.deepcopy(instance.jobs)
+
+        while len(new_jobs) > target_jobs:
+            new_jobs.pop(random.randint(0, len(new_jobs) - 1))
+
+        return JobShopInstance(new_jobs, instance.name)
+
+    @staticmethod
+    def remove_job(
+        instance: JobShopInstance, job_index: int
+    ) -> JobShopInstance:
+        """Removes a specific job from the instance.
+
+        Args:
+            instance: The JobShopInstance from which to remove the job.
+            job_index: The index of the job to remove.
+
+        Returns:
+            A new JobShopInstance with the specified job removed.
+        """
+        new_jobs = copy.deepcopy(instance.jobs)
+        new_jobs.pop(job_index)
+        return JobShopInstance(new_jobs, instance.name)

{job_shop_lib-0.1.2 → job_shop_lib-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "job-shop-lib"
-version = "0.1.2"
+version = "0.2.0"
 description = "An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)"
 authors = ["Pabloo22 <pablete.arino@gmail.com>"]
 license = "MIT"
@@ -12,7 +12,7 @@ include = ["benchmarks/benchmark_instances.json"]
 python = "^3.10"
 ortools = "^9"
 matplotlib = "^3"
-pyarrow = "^14.0.0"  # An optional pandas' dependency that will be required in the future
+pyarrow = "^15.0.0"  # An optional pandas' dependency that will be required in the future
 networkx = "^3"
 imageio = "^2"
 pygraphviz = {version = "^1.12", optional = true}