tuner: Renamed Optimizer to Tuner

Fixes: #1200
intel · Oct 1, 2021 · 002d7f5 · 002d7f5
1 parent a434df7
commit 002d7f5
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 31 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -46,6 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Spacy `model_name_or_path` was changed to `model_name`. Functionality is the
   same, it still accepts a name or a path.
 - Renamed `accuracy()` to `score()`.
+- Renamed `Optimizer` to `Tuner`.
 ### Fixed
 - Record object key properties are now always strings
 

diff --git a/dffml/optimizer/__init__.py → dffml/tuner/__init__.py b/dffml/optimizer/__init__.py → dffml/tuner/__init__.py
@@ -1,11 +1,11 @@
 # SPDX-License-Identifier: MIT
 # Copyright (c) 2020 Intel Corporation
 """
-This is the Optimizer plugin
+This is the Tuner plugin
 """
-from .optimizer import (
-    OptimizerConfig,
-    OptimizerContext,
-    Optimizer,
+from .tuner import (
+    TunerConfig,
+    TunerContext,
+    Tuner,
 )
 from .parameter_grid import ParameterGrid
diff --git a/dffml/optimizer/parameter_grid.py → dffml/tuner/parameter_grid.py b/dffml/optimizer/parameter_grid.py → dffml/tuner/parameter_grid.py
@@ -7,7 +7,7 @@
     field,
 )
 from ..high_level.ml import train, score
-from .optimizer import Optimizer, OptimizerContext
+from .tuner import Tuner, TunerContext
 from ..util.entrypoint import entrypoint
 from ..source.source import BaseSource, Record
 from ..accuracy.accuracy import AccuracyScorer, AccuracyContext
@@ -20,9 +20,9 @@ class ParameterGridConfig:
     parameters: dict = field("Parameters to be optimized")
 
 
-class ParameterGridContext(OptimizerContext):
+class ParameterGridContext(TunerContext):
     """
-    Parameter Grid Optimizer
+    Parameter Grid Tuner
     """
 
     async def optimize(
@@ -92,7 +92,7 @@ async def optimize(
 
 
 @entrypoint("parameter_grid")
-class ParameterGrid(Optimizer):
+class ParameterGrid(Tuner):
 
     CONFIG = ParameterGridConfig
     CONTEXT = ParameterGridContext
diff --git a/dffml/optimizer/optimizer.py → dffml/tuner/tuner.py b/dffml/optimizer/optimizer.py → dffml/tuner/tuner.py
@@ -13,12 +13,12 @@
 
 
 @config
-class OptimizerConfig:
+class TunerConfig:
     pass
 
 
-class OptimizerContext(abc.ABC, BaseDataFlowFacilitatorObjectContext):
-    def __init__(self, parent: "Optimizer") -> None:
+class TunerContext(abc.ABC, BaseDataFlowFacilitatorObjectContext):
+    def __init__(self, parent: "Tuner") -> None:
         self.parent = parent
 
     @abc.abstractmethod
@@ -58,15 +58,15 @@ async def optimize(
         raise NotImplementedError()
 
 
-@base_entry_point("dffml.optimizer", "optimizer")
-class Optimizer(BaseDataFlowFacilitatorObject):
+@base_entry_point("dffml.tuner", "tuner")
+class Tuner(BaseDataFlowFacilitatorObject):
     """
     Abstract base class which should be derived from
-    and implemented using various optimizers.
+    and implemented using various tuners.
     """
 
-    CONFIG = OptimizerConfig
-    CONTEXT = OptimizerContext
+    CONFIG = TunerConfig
+    CONTEXT = TunerContext
 
-    def __call__(self) -> OptimizerContext:
+    def __call__(self) -> TunerContext:
         return self.CONTEXT(self)
diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst
@@ -16,6 +16,6 @@ open an `issue <https://github.com/intel/dffml/issues/new?assignees=&labels=docu
     dffml_source
     dffml_model
     dffml_accuracy
-    dffml_optimizer
+    dffml_tuner
     dffml_operation
     dffml_service_cli
diff --git a/examples/notebooks/tuning_models.ipynb b/examples/notebooks/tuning_models.ipynb
@@ -348,7 +348,7 @@
    "execution_count": 13,
    "source": [
     "from dffml.accuracy import MeanSquaredErrorAccuracy\n",
-    "from dffml.optimizer import ParameterGrid\n",
+    "from dffml.tuner import ParameterGrid\n",
     "\n",
     "parameter_optim = ParameterGrid(\n",
     "    parameters = {\n",
@@ -358,8 +358,8 @@
     "    }\n",
     ")\n",
     "async with contextlib.AsyncExitStack() as astack:\n",
-    "    optimizer = await astack.enter_async_context(parameter_optim)\n",
-    "    octx = await astack.enter_async_context(optimizer())\n",
+    "    tuner = await astack.enter_async_context(parameter_optim)\n",
+    "    octx = await astack.enter_async_context(tuner())\n",
     "\n",
     "tuned_accuracy1 = await octx.optimize(model, predict_feature, scorer, train_data, test_data)\n",
     "print(\"Tuned Accuracy:\", tuned_accuracy1)"

diff --git a/scripts/docs/templates/dffml_optimizer.rst b/scripts/docs/templates/dffml_optimizer.rst
diff --git a/scripts/docs/templates/dffml_tuner.rst b/scripts/docs/templates/dffml_tuner.rst
@@ -0,0 +1,6 @@
+Tuner
+=====
+
+Tuners are implementations of :class:`dffml.tuner.Tuner`,
+they abstract the usage of tuning methods.
+
diff --git a/setup.py b/setup.py
@@ -169,9 +169,9 @@ class InstallException(Exception):
             "mse = dffml.accuracy.mse:MeanSquaredErrorAccuracy",
             "clf = dffml.accuracy.clf:ClassificationAccuracy",
         ],
-        # Optimizer
-        "dffml.optimizer": [
-            "parameter_grid = dffml.optimizer.parameter_grid:ParameterGrid",
+        # Tuner
+        "dffml.tuner": [
+            "parameter_grid = dffml.tuner.parameter_grid:ParameterGrid",
         ],
     },
 )