fix: rename module names.

optuna · Oct 2, 2024 · 0bc6cb7 · 0bc6cb7
1 parent 888441c
commit 0bc6cb7
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/package/samplers/multi_armed_bandit/LICENSE → package/samplers/mab_epsilon_greedy/LICENSE b/package/samplers/multi_armed_bandit/LICENSE → package/samplers/mab_epsilon_greedy/LICENSE
diff --git a/...age/samplers/multi_armed_bandit/README.md → ...age/samplers/mab_epsilon_greedy/README.md b/...age/samplers/multi_armed_bandit/README.md → ...age/samplers/mab_epsilon_greedy/README.md
@@ -1,6 +1,6 @@
 ---
 author: Ryota Nishijima
-title: Multi-armed Bandit Sampler
+title: MAB Epsilon-Greedy Sampler
 description: Sampler based on multi-armed bandit algorithm with epsilon-greedy arm selection.
 tags: [sampler, multi-armed bandit]
 optuna_versions: [4.0.0]
@@ -9,16 +9,16 @@ license: MIT License
 
 ## Class or Function Names
 
-- MultiArmedBanditSampler
+- MABEpsilonGreedySampler
 
 ## Example
 
 ```python
-mod = optunahub.load_module("samplers/multi_armed_bandit")
-sampler = mod.MultiArmedBanditSampler()
+mod = optunahub.load_module("samplers/mab_epsilon_greedy")
+sampler = mod.MABEpsilonGreedySampler()
 ```
 
-See [`example.py`](https://github.com/optuna/optunahub-registry/blob/main/package/samplers/multi_armed_bandit/example.py) for more details.
+See [`example.py`](https://github.com/optuna/optunahub-registry/blob/main/package/samplers/mab_epsilon_greedy/example.py) for more details.
 
 ## Others
 

diff --git a/package/samplers/mab_epsilon_greedy/__init__.py b/package/samplers/mab_epsilon_greedy/__init__.py
@@ -0,0 +1,4 @@
+from .mab_epsilon_greedy import MABEpsilonGreedySampler
+
+
+__all__ = ["MABEpsilonGreedySampler"]
diff --git a/...ge/samplers/multi_armed_bandit/example.py → ...ge/samplers/mab_epsilon_greedy/example.py b/...ge/samplers/multi_armed_bandit/example.py → ...ge/samplers/mab_epsilon_greedy/example.py
@@ -4,9 +4,9 @@
 
 if __name__ == "__main__":
     module = optunahub.load_module(
-        package="samplers/multi_armed_bandit",
+        package="samplers/mab_epsilon_greedy",
     )
-    sampler = module.MultiArmedBanditSampler()
+    sampler = module.MABEpsilonGreedySampler()
 
     def objective(trial: optuna.Trial) -> float:
         x = trial.suggest_categorical("arm_1", [1, 2, 3])

diff --git a/.../multi_armed_bandit/multi_armed_bandit.py → .../mab_epsilon_greedy/mab_epsilon_greedy.py b/.../multi_armed_bandit/multi_armed_bandit.py → .../mab_epsilon_greedy/mab_epsilon_greedy.py
@@ -10,7 +10,7 @@
 from optuna.trial import TrialState
 
 
-class MultiArmedBanditSampler(RandomSampler):
+class MABEpsilonGreedySampler(RandomSampler):
     """Sampler based on Multi-armed Bandit Algorithm.
 
     Args:

diff --git a/package/samplers/multi_armed_bandit/__init__.py b/package/samplers/multi_armed_bandit/__init__.py
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		from .mab_epsilon_greedy import MABEpsilonGreedySampler


		__all__ = ["MABEpsilonGreedySampler"]