Rename client to experiment

Epistimio · Jan 6, 2023 · c60e8d4 · c60e8d4
1 parent b8d0aac
commit c60e8d4
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 19 deletions.
diff --git a/example/config.yaml b/example/config.yaml
@@ -4,14 +4,14 @@ defaults:
 hydra:
   job:
     env_set:
-      PREVIOUS_CHECKPOINT: ${hydra.sweeper.client.previous_checkpoint}
+      PREVIOUS_CHECKPOINT: ${hydra.sweeper.experiment.previous_checkpoint}
       CURRENT_CHECKPOINT: ${hydra.runtime.output_dir}
 
   # makes sure each multirun ends up in a unique folder
   # the defaults can make overlapping folders
   sweep:
     dir: multirun/${now:%Y-%m-%d}/${now:%H-%M-%S}
-    subdir: ${hydra.sweeper.client.name}/${hydra.sweeper.client.uuid}/${hydra.job.id}
+    subdir: ${hydra.sweeper.experiment.name}/${hydra.sweeper.experiment.uuid}/${hydra.job.id}
 
   sweeper:
     # default parametrization of the search space
@@ -23,7 +23,7 @@ hydra:
       batch_size: "uniform(4, 16, discrete=True)"
       epoch: "fidelity(3, 100)"
 
-    client:
+    experiment:
       name: 'experiment'
       version: '1'
 

diff --git a/hydra_plugins/hydra_orion_sweeper/config.py b/hydra_plugins/hydra_orion_sweeper/config.py
@@ -84,7 +84,7 @@ class OrionSweeperConf:
 
     _target_: str = "hydra_plugins.hydra_orion_sweeper.orion_sweeper.OrionSweeper"
 
-    client: OrionClientConf = OrionClientConf()
+    experiment: OrionClientConf = OrionClientConf()
 
     worker: WorkerConf = WorkerConf()
 

diff --git a/hydra_plugins/hydra_orion_sweeper/implementation.py b/hydra_plugins/hydra_orion_sweeper/implementation.py
@@ -167,11 +167,11 @@ def as_overrides(trial, additional, uuid, prev_checkpoint):
     args = [f"{k}={v}" for k, v in kwargs.items()]
 
     args += [
-        f"hydra.sweeper.client.id={trial.experiment}",
-        f"hydra.sweeper.client.trial={trial.id}",
-        f"hydra.sweeper.client.uuid={uuid}",
-        f"hydra.sweeper.client.previous_checkpoint={prev_checkpoint}",
-        # "hydra.sweeper.client.current_checkpoint=$hydra.runtime.output_dir",
+        f"hydra.sweeper.experiment.id={trial.experiment}",
+        f"hydra.sweeper.experiment.trial={trial.id}",
+        f"hydra.sweeper.experiment.uuid={uuid}",
+        f"hydra.sweeper.experiment.previous_checkpoint={prev_checkpoint}",
+        # "hydra.sweeper.experiment.current_checkpoint=$hydra.runtime.output_dir",
     ]
     return tuple(args)
 
@@ -341,7 +341,7 @@ class OrionSweeperImpl(Sweeper):
 
     def __init__(
         self,
-        client: OrionClientConf,
+        experiment: OrionClientConf,
         worker: WorkerConf,
         algorithm: AlgorithmConf,
         storage: StorageConf,
@@ -355,7 +355,7 @@ def __init__(
         self.uuid = uuid.uuid1().hex
         self.resume_paths = dict()
 
-        self.orion_config = client
+        self.orion_config = experiment
         self.worker_config = worker
         self.algo_config = algorithm
         self.storage_config = storage

diff --git a/hydra_plugins/hydra_orion_sweeper/orion_sweeper.py b/hydra_plugins/hydra_orion_sweeper/orion_sweeper.py
@@ -18,7 +18,7 @@ class OrionSweeper(Sweeper):
 
     def __init__(
         self,
-        client: OrionClientConf,
+        experiment: OrionClientConf,
         worker: WorkerConf,
         algorithm: AlgorithmConf,
         storage: StorageConf,
@@ -30,15 +30,15 @@ def __init__(
         # >>> Remove with Issue #8
         if parametrization is not None and params is None:
             warn(
-                "`hydra.sweeper.orion.parametrization` is deprecated;"
+                "`hydra.sweeper.experiment.parametrization` is deprecated;"
                 "use `hydra.sweeper.params` instead",
                 DeprecationWarning,
             )
             params = parametrization
 
         elif parametrization is not None and params is not None:
             warn(
-                "Both `hydra.sweeper.orion.parametrization` and `hydra.sweeper.params` are defined;"
+                "Both `hydra.sweeper.experiment.parametrization` and `hydra.sweeper.params` are defined;"
                 "using `hydra.sweeper.params`",
                 DeprecationWarning,
             )
@@ -47,7 +47,7 @@ def __init__(
         if params is None:
             params = dict()
 
-        self.sweeper = OrionSweeperImpl(client, worker, algorithm, storage, params)
+        self.sweeper = OrionSweeperImpl(experiment, worker, algorithm, storage, params)
 
     def setup(
         self,

diff --git a/tests/hydra_config.py b/tests/hydra_config.py
@@ -7,7 +7,7 @@
         },
         "sweeper": {
             "_target_": "hydra_plugins.hydra_orion_sweeper.orion_sweeper.OrionSweeper",
-            "client": {
+            "experiment": {
                 "name": None,
                 "version": None,
                 "branching": None,

diff --git a/tests/test_orion.py b/tests/test_orion.py
@@ -42,7 +42,7 @@ def load_hydra_testing_config():
 
 def orion_configuration():
     return dict(
-        client=OmegaConf.structured(OrionClientConf()),
+        experiment=OmegaConf.structured(OrionClientConf()),
         worker=OmegaConf.structured(WorkerConf()),
         algorithm=OmegaConf.structured(AlgorithmConf()),
         storage=OmegaConf.structured(StorageConf()),

diff --git a/tests/test_warnings.py b/tests/test_warnings.py
@@ -25,7 +25,7 @@ def test_parametrization_is_deprecated():
     assert (
         warnings[0]
         .message.args[0]
-        .startswith("`hydra.sweeper.orion.parametrization` is deprecated;")
+        .startswith("`hydra.sweeper.experiment.parametrization` is deprecated;")
     )
 
 
@@ -44,7 +44,7 @@ def test_parametrization_and_params():
     assert (
         warnings[0]
         .message.args[0]
-        .startswith("Both `hydra.sweeper.orion.parametrization` and")
+        .startswith("Both `hydra.sweeper.experiment.parametrization` and")
     )