Move components into submodule

miplearn/__init__.py

@@ -3,10 +3,12 @@
 # Written by Alinson S. Xavier <axavier@anl.gov>
 
 
-from .component import Component
+from .components.component import Component
+from .components.warmstart import (WarmStartComponent,
+                                   KnnWarmStartPredictor,
+                                   LogisticWarmStartPredictor)
+from .components.branching import BranchPriorityComponent
+from .extractors import UserFeaturesExtractor, SolutionExtractor
+from .benchmark import BenchmarkRunner
 from .instance import Instance
 from .solvers import LearningSolver
-from .benchmark import BenchmarkRunner
-from .warmstart import WarmStartComponent, KnnWarmStartPredictor, LogisticWarmStartPredictor
-from .branching import BranchPriorityComponent
-from .extractors import UserFeaturesExtractor, SolutionExtractor

miplearn/components/branching.py

@@ -2,8 +2,8 @@
 # Copyright (C) 2019-2020 Argonne National Laboratory. All rights reserved.
 # Written by Alinson S. Xavier <axavier@anl.gov>
 
-from . import Component
-from .extractors import Extractor
+from .component import Component
+from ..extractors import Extractor
 from abc import ABC, abstractmethod
 from sklearn.neighbors import KNeighborsRegressor
 import numpy as np
@@ -52,7 +52,7 @@ class BranchPriorityComponent(Component):
             src_dirname = os.path.dirname(os.path.realpath(__file__))
             priority_file = tempfile.NamedTemporaryFile(mode="r")
             subprocess.run(["julia",
-                            "%s/scripts/branchpriority.jl" % src_dirname,
+                            "%s/branching.jl" % src_dirname,
                             lp_file.name,
                             priority_file.name,
                             str(self.node_limit),

miplearn/components/component.py

@@ -6,9 +6,9 @@ from abc import ABC, abstractmethod
 
 
 class Component(ABC):
-    @abstractmethod
-    def fit(self, solver):
-        pass
+    """
+    A Component is an object which adds functionality to a LearningSolver.
+    """
     
     @abstractmethod
     def before_solve(self, solver, instance, model):
@@ -21,3 +21,7 @@ class Component(ABC):
     @abstractmethod
     def merge(self, other):
         pass
+    
+    @abstractmethod
+    def fit(self, solver):
+        pass

miplearn/components/tests/test_warmstart_knn.py

@@ -2,7 +2,7 @@
 # Copyright (C) 2019-2020 Argonne National Laboratory. All rights reserved.
 # Written by Alinson S. Xavier <axavier@anl.gov>
 
-from miplearn.warmstart import KnnWarmStartPredictor
+from miplearn import KnnWarmStartPredictor
 from sklearn.metrics import accuracy_score, precision_score
 import numpy as np
 

miplearn/components/tests/test_warmstart_logistic.py

@@ -2,7 +2,7 @@
 # Copyright (C) 2019-2020 Argonne National Laboratory. All rights reserved.
 # Written by Alinson S. Xavier <axavier@anl.gov>
 
-from miplearn.warmstart import LogisticWarmStartPredictor
+from miplearn import LogisticWarmStartPredictor
 from sklearn.metrics import accuracy_score, precision_score
 import numpy as np
 

miplearn/components/warmstart.py

@@ -2,8 +2,8 @@
 # Copyright (C) 2019-2020 Argonne National Laboratory. All rights reserved.
 # Written by Alinson S. Xavier <axavier@anl.gov>
 
-from . import Component
-from .extractors import *
+from .component import Component
+from ..extractors import *
 
 from abc import ABC, abstractmethod
 from copy import deepcopy

miplearn/solvers.py

@@ -2,8 +2,7 @@
 # Copyright (C) 2019-2020 Argonne National Laboratory. All rights reserved.
 # Written by Alinson S. Xavier <axavier@anl.gov>
 
-from .warmstart import WarmStartComponent
-from .branching import BranchPriorityComponent
+from . import WarmStartComponent, BranchPriorityComponent
 import pyomo.environ as pe
 import numpy as np
 from copy import deepcopy

miplearn/tests/test_benchmark.py

@@ -2,8 +2,7 @@
 # Copyright (C) 2019-2020 Argonne National Laboratory. All rights reserved.
 # Written by Alinson S. Xavier <axavier@anl.gov>
 
-from miplearn import LearningSolver, BenchmarkRunner
-from miplearn.warmstart import KnnWarmStartPredictor
+from miplearn import LearningSolver, BenchmarkRunner, KnnWarmStartPredictor
 from miplearn.problems.stab import MaxWeightStableSetGenerator
 from scipy.stats import randint
 import numpy as np

miplearn/tests/test_solver.py

@@ -2,10 +2,8 @@
 # Copyright (C) 2019-2020 Argonne National Laboratory. All rights reserved.
 # Written by Alinson S. Xavier <axavier@anl.gov>
 
-from miplearn import LearningSolver
+from miplearn import LearningSolver, BranchPriorityComponent, WarmStartComponent
 from miplearn.problems.knapsack import KnapsackInstance
-from miplearn.branching import BranchPriorityComponent
-from miplearn.warmstart import WarmStartComponent
 import numpy as np