Introduce ddwp module

leonlan · Sep 20, 2023 · 751d598 · 751d598
1 parent f882eb2
commit 751d598
Show file tree

Hide file tree

Showing 28 changed files with 38 additions and 39 deletions.
diff --git a/benchmark.py b/benchmark.py
@@ -9,11 +9,11 @@
 from tqdm import tqdm
 from tqdm.contrib.concurrent import process_map
 
-import utils
-from agents import AGENTS, Agent
-from Environment import Environment
-from sampling import SAMPLING_METHODS
-from static_solvers import default_solver
+from ddwp.agents import AGENTS, Agent
+from ddwp.Environment import Environment
+from ddwp.read import read
+from ddwp.sampling import SAMPLING_METHODS
+from ddwp.static_solvers import default_solver
 
 
 def parse_args():
@@ -78,7 +78,7 @@ def solve(
         raise ValueError("Strategy time limit >= epoch time limit.")
 
     path = Path(loc)
-    static_instance = utils.read(path, instance_format)
+    static_instance = read(path, instance_format)
 
     if environment == "euro_neurips":
         env_constructor = Environment.euro_neurips  # type: ignore

diff --git a/Environment.py → ddwp/Environment.py b/Environment.py → ddwp/Environment.py
@@ -27,9 +27,9 @@
 
 import numpy as np
 
-from sampling import SamplingMethod
-from utils.validation import validate_static_solution
-from VrpInstance import VrpInstance
+from ddwp.sampling import SamplingMethod
+from ddwp.validation import validate_static_solution
+from ddwp.VrpInstance import VrpInstance
 
 Instance = dict
 Action = list[list[int]]

diff --git a/VrpInstance.py → ddwp/VrpInstance.py b/VrpInstance.py → ddwp/VrpInstance.py
diff --git a/ddwp/__init__.py b/ddwp/__init__.py
diff --git a/agents/Agent.py → ddwp/agents/Agent.py b/agents/Agent.py → ddwp/agents/Agent.py
@@ -1,6 +1,6 @@
 from typing import Protocol
 
-from Environment import State, StaticInfo
+from ddwp.Environment import State, StaticInfo
 
 
 class Agent(Protocol):

diff --git a/agents/IterativeConditionalDispatch.py → ddwp/agents/IterativeConditionalDispatch.py b/agents/IterativeConditionalDispatch.py → ddwp/agents/IterativeConditionalDispatch.py
@@ -4,10 +4,10 @@
 
 import numpy as np
 
-from Environment import State, StaticInfo
-from sampling import SamplingMethod
-from static_solvers import default_solver, scenario_solver
-from VrpInstance import VrpInstance
+from ddwp.Environment import State, StaticInfo
+from ddwp.sampling import SamplingMethod
+from ddwp.static_solvers import default_solver, scenario_solver
+from ddwp.VrpInstance import VrpInstance
 
 from .consensus import CONSENSUS, ConsensusFunction
 from .sample_scenario import sample_scenario

diff --git a/agents/RandomDispatch.py → ddwp/agents/RandomDispatch.py b/agents/RandomDispatch.py → ddwp/agents/RandomDispatch.py
@@ -1,7 +1,7 @@
 import numpy as np
 
-from Environment import State, StaticInfo
-from static_solvers import default_solver
+from ddwp.Environment import State, StaticInfo
+from ddwp.static_solvers import default_solver
 
 
 class _RandomDispatch:

diff --git a/agents/RollingHorizon.py → ddwp/agents/RollingHorizon.py b/agents/RollingHorizon.py → ddwp/agents/RollingHorizon.py
@@ -1,8 +1,8 @@
 import numpy as np
 
-from Environment import State, StaticInfo
-from sampling import SamplingMethod
-from static_solvers import default_solver
+from ddwp.Environment import State, StaticInfo
+from ddwp.sampling import SamplingMethod
+from ddwp.static_solvers import default_solver
 
 from .sample_scenario import sample_scenario
 

diff --git a/agents/__init__.py → ddwp/agents/__init__.py b/agents/__init__.py → ddwp/agents/__init__.py
diff --git a/agents/consensus/ConsensusFunction.py → ddwp/agents/consensus/ConsensusFunction.py b/agents/consensus/ConsensusFunction.py → ddwp/agents/consensus/ConsensusFunction.py
@@ -2,8 +2,8 @@
 
 import numpy as np
 
-from Environment import StaticInfo
-from VrpInstance import VrpInstance
+from ddwp.Environment import StaticInfo
+from ddwp.VrpInstance import VrpInstance
 
 
 class ConsensusFunction(Protocol):

diff --git a/agents/consensus/__init__.py → ddwp/agents/consensus/__init__.py b/agents/consensus/__init__.py → ddwp/agents/consensus/__init__.py
diff --git a/agents/consensus/fixed_threshold.py → ddwp/agents/consensus/fixed_threshold.py b/agents/consensus/fixed_threshold.py → ddwp/agents/consensus/fixed_threshold.py
@@ -1,6 +1,6 @@
 import numpy as np
 
-from Environment import StaticInfo
+from ddwp.Environment import StaticInfo
 
 from .utils import (
     select_dispatch_on_threshold,

diff --git a/agents/consensus/hamming_distance.py → ddwp/agents/consensus/hamming_distance.py b/agents/consensus/hamming_distance.py → ddwp/agents/consensus/hamming_distance.py
@@ -1,6 +1,6 @@
 import numpy as np
 
-from Environment import StaticInfo
+from ddwp.Environment import StaticInfo
 
 from .utils import (
     get_dispatch_matrix,

diff --git a/agents/consensus/prize_collecting.py → ddwp/agents/consensus/prize_collecting.py b/agents/consensus/prize_collecting.py → ddwp/agents/consensus/prize_collecting.py
@@ -1,7 +1,7 @@
 import numpy as np
 
-from Environment import StaticInfo
-from static_solvers import default_solver
+from ddwp.Environment import StaticInfo
+from ddwp.static_solvers import default_solver
 
 from .utils import get_dispatch_count, verify_action
 

diff --git a/agents/consensus/utils.py → ddwp/agents/consensus/utils.py b/agents/consensus/utils.py → ddwp/agents/consensus/utils.py
diff --git a/agents/sample_scenario.py → ddwp/agents/sample_scenario.py b/agents/sample_scenario.py → ddwp/agents/sample_scenario.py
@@ -1,8 +1,8 @@
 import numpy as np
 
-from Environment import State, StaticInfo
-from sampling import SamplingMethod
-from VrpInstance import VrpInstance
+from ddwp.Environment import State, StaticInfo
+from ddwp.sampling import SamplingMethod
+from ddwp.VrpInstance import VrpInstance
 
 
 def sample_scenario(

diff --git a/utils/read.py → ddwp/read.py b/utils/read.py → ddwp/read.py
@@ -3,7 +3,7 @@
 import numpy as np
 import vrplib
 
-from VrpInstance import VrpInstance
+from ddwp.VrpInstance import VrpInstance
 
 
 def read(path: Path, instance_format: str = "vrplib"):

diff --git a/sampling/SamplingMethod.py → ddwp/sampling/SamplingMethod.py b/sampling/SamplingMethod.py → ddwp/sampling/SamplingMethod.py
@@ -2,7 +2,7 @@
 
 from numpy.random import Generator
 
-from VrpInstance import VrpInstance
+from ddwp.VrpInstance import VrpInstance
 
 
 class SamplingMethod(Protocol):

diff --git a/sampling/__init__.py → ddwp/sampling/__init__.py b/sampling/__init__.py → ddwp/sampling/__init__.py
diff --git a/sampling/custom_time_windows.py → ddwp/sampling/custom_time_windows.py b/sampling/custom_time_windows.py → ddwp/sampling/custom_time_windows.py
@@ -1,7 +1,7 @@
 import numpy as np
 from numpy.random import Generator
 
-from VrpInstance import VrpInstance
+from ddwp.VrpInstance import VrpInstance
 
 
 def custom_time_windows(

diff --git a/sampling/euro_neurips.py → ddwp/sampling/euro_neurips.py b/sampling/euro_neurips.py → ddwp/sampling/euro_neurips.py
@@ -1,7 +1,7 @@
 import numpy as np
 from numpy.random import Generator
 
-from VrpInstance import VrpInstance
+from ddwp.VrpInstance import VrpInstance
 
 
 def euro_neurips(

diff --git a/static_solvers/__init__.py → ddwp/static_solvers/__init__.py b/static_solvers/__init__.py → ddwp/static_solvers/__init__.py
diff --git a/static_solvers/default_solver.py → ddwp/static_solvers/default_solver.py b/static_solvers/default_solver.py → ddwp/static_solvers/default_solver.py
@@ -1,7 +1,7 @@
 from pyvrp import Model, Result
 from pyvrp.stop import MaxRuntime
 
-from VrpInstance import VrpInstance
+from ddwp.VrpInstance import VrpInstance
 
 from .instance2data import instance2data
 

diff --git a/static_solvers/instance2data.py → ddwp/static_solvers/instance2data.py b/static_solvers/instance2data.py → ddwp/static_solvers/instance2data.py
@@ -3,7 +3,7 @@
 import numpy as np
 from pyvrp import Client, ProblemData, VehicleType
 
-from VrpInstance import VrpInstance
+from ddwp.VrpInstance import VrpInstance
 
 
 def instance2data(instance: VrpInstance) -> ProblemData:

diff --git a/static_solvers/scenario_solver.py → ddwp/static_solvers/scenario_solver.py b/static_solvers/scenario_solver.py → ddwp/static_solvers/scenario_solver.py
@@ -26,7 +26,7 @@
 )
 from pyvrp.stop import MaxRuntime
 
-from VrpInstance import VrpInstance
+from ddwp.VrpInstance import VrpInstance
 
 from .instance2data import instance2data
 

diff --git a/utils/validation.py → ddwp/validation.py b/utils/validation.py → ddwp/validation.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "dynamic-dispatch-waves"
+name = "ddwp"
 version = "0.1.0"
 description = "Code for dynamic dispatch waves problem"
 authors = [
@@ -8,7 +8,8 @@ authors = [
     "Niels Wouda <n.a.wouda@rug.nl>",
 ]
 license = "MIT"
-packages = [{include = "benchmark.py"}]
+readme = "README.md"
+packages = [{include ="ddwp"}, {include = "benchmark.py"}]
 
 
 [tool.poetry.dependencies]

diff --git a/utils/__init__.py b/utils/__init__.py