New example: Maintenance Scheduling

Author: CameleoGrey

README.md

@@ -44,7 +44,6 @@ maturin develop --release
 -  maturin will build the Rust part, get all Python dependencies (for solver itself, not examples) and install greyjack to your venv
 
 # RoadMap
-- Add more examples: Job-Shop, Pickup&Delivery, some continuous and MIP tasks, scheduling, etc
 - Types, arguments validation
 - Write docs
 - Tests, tests, tests...

examples/object_oriented/boiler_plate_code/persistence/CotwinBuilder.py

@@ -29,7 +29,18 @@ def build_cotwin(self, domain, is_already_initialized):
         cotwin.set_score_calculator( score_calculator )
 
         return cotwin
-
+    
+    def _build_some_planning_entities(self, domain, is_already_initialized):
+        return some_planning_entities
+    
+    def _build_some_problem_facts(self, domain):
+        return some_problem_facts
+
+    def _remove_redundant_fields(self, entities_list, redundant_fields):
+
+        for i in range(len(entities_list)):
+            for field_name in redundant_fields:
+                delattr(entities_list[i], field_name)
 
 
 

examples/object_oriented/boiler_plate_code/score/IncrementalScoreCalculator.py

@@ -1,6 +1,6 @@
 
 from greyjack.score_calculation.score_calculators.IncrementalScoreCalculator import IncrementalScoreCalculator
-from greyjack.score_calculation.scores.SimpleScore import SimpleScore
+from greyjack.score_calculation.scores.HardSoftScore import HardSoftScore
 from greyjack.score_calculation.scores.ScoreVariants import ScoreVariants
 import polars as pl
 import numpy as np
@@ -11,10 +11,10 @@
 class IncrementalScoreCalculator(IncrementalScoreCalculator):
     def __init__(self):
         super().__init__()
-        self.score_variant = ScoreVariants.SimpleScore
-        self.add_constraint("some_constraint_function", self.some_constraint_function)
+        self.score_variant = ScoreVariants.HardSoftScore
+        self.add_constraint("all_in_one_constraint", self.all_in_one_constraint)
         pass
 
-    def some_constraint_function(self, planning_entity_dfs, problem_fact_dfs, delta_dfs):
+    def all_in_one_constraint(self, planning_entity_dfs, problem_fact_dfs, delta_dfs):
 
         return scores

examples/object_oriented/boiler_plate_code/score/PlainScoreCalculator.py

@@ -1,7 +1,7 @@
 
 
 from greyjack.score_calculation.score_calculators.PlainScoreCalculator import PlainScoreCalculator
-from greyjack.score_calculation.scores.SimpleScore import SimpleScore
+from greyjack.score_calculation.scores.HardSoftScore import HardSoftScore
 from greyjack.score_calculation.scores.ScoreVariants import ScoreVariants
 import polars as pl
 
@@ -11,7 +11,7 @@ def __init__(self):
 
         super().__init__()
 
-        self.score_variant = ScoreVariants.SimpleScore
+        self.score_variant = ScoreVariants.HardSoftScore
 
         self.add_constraint("some_constraint_function", self.some_constraint_function)
 

examples/object_oriented/boiler_plate_code/scripts/solve_task.py

@@ -19,14 +19,13 @@
 
 if __name__ == "__main__":
 
-    # build domain model
     domain_builder = DomainBuilder(random_seed=45)
-    cotwin_builder = CotwinBuilder(use_incremental_score_calculator=True)
+    cotwin_builder = CotwinBuilder(use_incremental_score_calculator=False, use_greed_init=False)
 
     #termination_strategy = StepsLimit(step_count_limit=1000)
-    #termination_strategy = TimeSpentLimit(time_seconds_limit=60)
+    termination_strategy = TimeSpentLimit(time_seconds_limit=60)
     #termination_strategy = ScoreNoImprovement(time_seconds_limit=15)
-    termination_strategy = ScoreLimit(score_to_compare=[0])
+    #termination_strategy = ScoreLimit(score_to_compare=[0, 0])
     agent = TabuSearch(neighbours_count=20, tabu_entity_rate=0.0, 
                        mutation_rate_multiplier=None, move_probas=[0.5, 0.5, 0, 0, 0, 0], 
                        migration_frequency=10, termination_strategy=termination_strategy)
@@ -42,7 +41,7 @@
 
     solver = SolverOOP(domain_builder, cotwin_builder, agent, 
                     ParallelizationBackend.Multiprocessing, LoggingLevel.FreshOnly,
-                    n_jobs=10, score_precision=[0])
+                    n_jobs=10, score_precision=[0, 0])
     solution = solver.solve()
 
     domain = domain_builder.build_from_solution(solution)

examples/object_oriented/cloud_balancing/scripts/solve_cloud_balancing.py

@@ -36,9 +36,9 @@
     #termination_strategy = TimeSpentLimit(time_seconds_limit=60)
     termination_strategy = ScoreNoImprovement(time_seconds_limit=15)
     #termination_strategy = ScoreLimit(score_to_compare=[0])
-    agent = TabuSearch(neighbours_count=20, tabu_entity_rate=0.8, 
+    agent = TabuSearch(neighbours_count=20, tabu_entity_rate=0.2, 
                        mutation_rate_multiplier=None, move_probas=[0.5, 0.5, 0.0, 0.0, 0.0, 0.0],
-                       migration_frequency=10, termination_strategy=termination_strategy)
+                       migration_frequency=10, compare_to_global_frequency=0, termination_strategy=termination_strategy)
     """agent = GeneticAlgorithm(population_size=128, crossover_probability=0.5, p_best_rate=0.2,
                              tabu_entity_rate=0.2, mutation_rate_multiplier=1.0, move_probas=[0.5, 0.5, 0.0, 0.0, 0.0, 0.0],
                              migration_rate=0.00001, migration_frequency=10, termination_strategy=termination_strategy)"""

examples/object_oriented/employee_scheduling/persistence/CotwinBuilder.py

@@ -121,14 +121,10 @@ def _add_utility_info_for_incremental_scoring(self, cotwin, score_calculator, pl
     def _build_planning_shifts(self, domain, is_already_initialized):
 
         if is_already_initialized:
-            raise Exception("Using initialized domain not initialized")
+            raise Exception("Use of existing domain object is not already implemented for this task")
 
         if self.use_greed_init:
-            raise Exception("greed initialization isn't implemented")
-        else:
-            n_employees = len(domain.employees)
-            initial_employee_ids = [random.randint(0, n_employees-1) for i in range(len(domain.shifts))]
-            #random.shuffle(initial_employee_ids)
+            raise Exception("greed init is not already implemented for this task")
 
         planning_shifts = []
         for i, current_shift in enumerate(domain.shifts):
@@ -139,7 +135,7 @@ def _build_planning_shifts(self, domain, is_already_initialized):
                     end = current_shift.end,
                     location = current_shift.location,
                     required_skill = current_shift.required_skill,
-                    employee = GJInteger(0, len(domain.employees)-1, False, initial_employee_ids[i]),
+                    employee = GJInteger(0, len(domain.employees)-1, False, None),
                 )
             )
 

examples/object_oriented/employee_scheduling/persistence/demo_data.py

@@ -2,6 +2,209 @@
 """
 Demo data generator from Timefold repo (with a little changes)
 """
+"""
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+"""
 
 
 from datetime import date, datetime, time, timedelta

examples/object_oriented/employee_scheduling/scripts/solve_task.py

@@ -27,7 +27,7 @@
     #termination_strategy = TimeSpentLimit(time_seconds_limit=60)
     termination_strategy = ScoreNoImprovement(time_seconds_limit=15)
     #termination_strategy = ScoreLimit(score_to_compare=[0, 20])
-    agent = TabuSearch(neighbours_count=20, tabu_entity_rate=0.2, 
+    agent = TabuSearch(neighbours_count=20, tabu_entity_rate=0.0, 
                        mutation_rate_multiplier=None, move_probas=[0.5, 0.5, 0, 0, 0, 0], 
                        migration_frequency=10, termination_strategy=termination_strategy)
     """agent = GeneticAlgorithm(population_size=128, crossover_probability=0.5, p_best_rate=0.05,

examples/object_oriented/maintenance_scheduling/__init__.py

@@ -0,0 +1,18 @@
+
+
+
+
+class CotJob:
+    def __init__(self, job_id=None, name=None, duration_in_days=None, min_start_date=None,
+                 max_end_date=None, ideal_end_date=None, tags=None, crew_id=None, start_date_id=None):
+        self.job_id = job_id
+        self.name = name
+        self.duration_in_days = duration_in_days
+        self.min_start_date = min_start_date
+        self.max_end_date = max_end_date
+        self.ideal_end_date = ideal_end_date
+
+        self.tags = tags
+
+        self.crew_id = crew_id
+        self.start_date_id = start_date_id # assigned work_day_list id

examples/object_oriented/maintenance_scheduling/cotwin/CotJob.py

@@ -0,0 +1,7 @@
+
+
+from greyjack.cotwin.CotwinBase import CotwinBase
+
+class Cotwin(CotwinBase):
+    def __init__(self):
+        super().__init__()

examples/object_oriented/maintenance_scheduling/cotwin/Cotwin.py

@@ -0,0 +1,12 @@
+
+
+
+
+class Crew:
+
+    def __init__(self, crew_id=None, name=None):
+
+        self.crew_id = crew_id
+        self.name = name
+
+        pass