diff --git a/package/samplers/multi_armed_bandit/LICENSE b/package/samplers/multi_armed_bandit/LICENSE new file mode 100644 index 00000000..cacc4256 --- /dev/null +++ b/package/samplers/multi_armed_bandit/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/package/samplers/multi_armed_bandit/README.md b/package/samplers/multi_armed_bandit/README.md new file mode 100644 index 00000000..5c9aecb3 --- /dev/null +++ b/package/samplers/multi_armed_bandit/README.md @@ -0,0 +1,25 @@ +--- +author: Ryota Nishijima +title: Multi-armed Bandit Sampler +description: Sampler based on multi-armed bandit algorithm with epsilon-greedy arm selection. +tags: [sampler, multi-armed bandit] +optuna_versions: [4.0.0] +license: MIT License +--- + +## Class or Function Names + +- MultiArmedBanditSampler + +## Example + +```python +mod = optunahub.load_module("samplers/multi_armed_bandit") +sampler = mod.MultiArmedBanditSampler() +``` + +See [`example.py`](https://github.com/optuna/optunahub-registry/blob/main/package/samplers/multi_armed_bandit/example.py) for more details. + +## Others + +This package provides a sampler based on Multi-armed bandit algorithm with epsilon-greedy selection. diff --git a/package/samplers/multi_armed_bandit/__init__.py b/package/samplers/multi_armed_bandit/__init__.py new file mode 100644 index 00000000..59718fd3 --- /dev/null +++ b/package/samplers/multi_armed_bandit/__init__.py @@ -0,0 +1,4 @@ +from .YOUR_TEMPLATE import YOUR_FEATURE + + +__all__ = ["YOUR_FEATURE"]