From 9b750d9dba63e344426bc4137b3850c15dadf6d4 Mon Sep 17 00:00:00 2001 From: Naoto Mizuno Date: Thu, 23 May 2024 16:47:14 +0900 Subject: [PATCH 1/2] Add built-in CmaEsSampler --- package/samplers/cmaes/LICENSE | 21 +++++++++++++++++ package/samplers/cmaes/README.md | 37 ++++++++++++++++++++++++++++++ package/samplers/cmaes/__init__.py | 4 ++++ 3 files changed, 62 insertions(+) create mode 100644 package/samplers/cmaes/LICENSE create mode 100644 package/samplers/cmaes/README.md create mode 100644 package/samplers/cmaes/__init__.py diff --git a/package/samplers/cmaes/LICENSE b/package/samplers/cmaes/LICENSE new file mode 100644 index 00000000..4e2b34c1 --- /dev/null +++ b/package/samplers/cmaes/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Preferred Networks, Inc. + +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/cmaes/README.md b/package/samplers/cmaes/README.md new file mode 100644 index 00000000..caa0c25f --- /dev/null +++ b/package/samplers/cmaes/README.md @@ -0,0 +1,37 @@ +--- +author: 'Optuna team' +title: 'CMA-ES Sampler' +description: 'A sampler using cmaes as the backend.' +tags: ['sampler', 'built-in'] +optuna_versions: ['3.6.1'] +license: 'MIT License' +--- + +## Class or Function Names +- CmaEsSampler + +## Installation +```bash +pip install cmaes +``` + +## Example +```python +import optuna +import optunahub + + +def objective(trial): + x = trial.suggest_float("x", -1, 1) + y = trial.suggest_int("y", -1, 1) + return x**2 + y + + +mod = optunahub.load_module("samplers/cmaes") +sampler = mod.CmaEsSampler() +study = optuna.create_study(sampler=sampler) +study.optimize(objective, n_trials=20) +``` + +## Others +See the [documentation](https://optuna.readthedocs.io/en/stable/reference/samplers/generated/optuna.samplers.CmaEsSampler.html) for more details. diff --git a/package/samplers/cmaes/__init__.py b/package/samplers/cmaes/__init__.py new file mode 100644 index 00000000..bdbb6b16 --- /dev/null +++ b/package/samplers/cmaes/__init__.py @@ -0,0 +1,4 @@ +from optuna.samplers import CmaEsSampler + + +__all__ = ["CmaEsSampler"] From 9e1b535c5205cd55d651ead9b6640733fbf601bf Mon Sep 17 00:00:00 2001 From: Naoto Mizuno Date: Fri, 24 May 2024 15:11:02 +0900 Subject: [PATCH 2/2] Add requirements.txt --- package/samplers/cmaes/requirements.txt | 1 + 1 file changed, 1 insertion(+) create mode 100644 package/samplers/cmaes/requirements.txt diff --git a/package/samplers/cmaes/requirements.txt b/package/samplers/cmaes/requirements.txt new file mode 100644 index 00000000..5139386f --- /dev/null +++ b/package/samplers/cmaes/requirements.txt @@ -0,0 +1 @@ +cmaes