Skip to content

Commit

Permalink
docs: multi-armed bandit.
Browse files Browse the repository at this point in the history
  • Loading branch information
ryota717 committed Sep 25, 2024
1 parent 733bce7 commit 8f0c8b4
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
21 changes: 21 additions & 0 deletions package/samplers/multi_armed_bandit/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 <Ryota Nishijima>

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.
25 changes: 25 additions & 0 deletions package/samplers/multi_armed_bandit/README.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions package/samplers/multi_armed_bandit/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from .YOUR_TEMPLATE import YOUR_FEATURE


__all__ = ["YOUR_FEATURE"]

0 comments on commit 8f0c8b4

Please sign in to comment.