From 4cd435f01eef191bcad7d327280d305972be56b8 Mon Sep 17 00:00:00 2001 From: y0z Date: Thu, 23 May 2024 12:51:17 +0900 Subject: [PATCH 1/6] Update Website URL --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 55079805..e8448d16 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,6 @@ OptunaHub Registry OptunaHub Registry is a registry service for sharing and discovering user-defined Optuna packages. It provides a platform for users to share their Optuna packages with others and discover useful packages created by other users. -See the [OptunaHub Website](https://optuna.github.io/optunahub-web/) for registered packages. +See the [OptunaHub Website](https://hub.optuna.org/) for registered packages. See also the [OptunaHub API documentation](https://optuna.github.io/optunahub/) for the API to use the registry, and the [OptunaHub tutorial](https://optuna.github.io/optunahub-registry/recipes/001_first.html) for how to register and discover packages. \ No newline at end of file From 9b750d9dba63e344426bc4137b3850c15dadf6d4 Mon Sep 17 00:00:00 2001 From: Naoto Mizuno Date: Thu, 23 May 2024 16:47:14 +0900 Subject: [PATCH 2/6] 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 2ab487355b2fe9ff55f6be95afa72ffd8406bb2a Mon Sep 17 00:00:00 2001 From: Naoto Mizuno Date: Thu, 23 May 2024 16:54:47 +0900 Subject: [PATCH 3/6] Add built-in GPSampler --- package/samplers/gp/LICENSE | 21 +++++++++++++++++++ package/samplers/gp/README.md | 36 +++++++++++++++++++++++++++++++++ package/samplers/gp/__init__.py | 4 ++++ 3 files changed, 61 insertions(+) create mode 100644 package/samplers/gp/LICENSE create mode 100644 package/samplers/gp/README.md create mode 100644 package/samplers/gp/__init__.py diff --git a/package/samplers/gp/LICENSE b/package/samplers/gp/LICENSE new file mode 100644 index 00000000..4e2b34c1 --- /dev/null +++ b/package/samplers/gp/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/gp/README.md b/package/samplers/gp/README.md new file mode 100644 index 00000000..1f59a9aa --- /dev/null +++ b/package/samplers/gp/README.md @@ -0,0 +1,36 @@ +--- +author: 'Optuna team' +title: 'Gaussian Process-Based Sampler' +description: 'Sampler using Gaussian process-based Bayesian optimization.' +tags: ['sampler', 'built-in'] +optuna_versions: ['3.6.1'] +license: 'MIT License' +--- + +## Class or Function Names +- GPSampler + +## Installation +```bash +pip install scipy pytorch +``` + +## Example +```python +import optuna +import optunahub + + +def objective(trial): + x = trial.suggest_float("x", -5, 5) + return x**2 + + +mod = optunahub.load_module("samplers/gp") +sampler = mod.GPSampler() +study = optuna.create_study(sampler=sampler) +study.optimize(objective, n_trials=100) +``` + +## Others +See the [documentation](https://optuna.readthedocs.io/en/stable/reference/samplers/generated/optuna.samplers.GPSampler.html) for more details. diff --git a/package/samplers/gp/__init__.py b/package/samplers/gp/__init__.py new file mode 100644 index 00000000..20772eb0 --- /dev/null +++ b/package/samplers/gp/__init__.py @@ -0,0 +1,4 @@ +from optuna.samplers import GPSampler + + +__all__ = ["GPSampler"] From d3211ff997ae3b2d7ec5f3950b896256630acfb1 Mon Sep 17 00:00:00 2001 From: Naoto Mizuno Date: Thu, 23 May 2024 18:04:28 +0900 Subject: [PATCH 4/6] Add built-in PartialFixedSampler --- package/samplers/partial_fixed/LICENSE | 21 +++++++++++++ package/samplers/partial_fixed/README.md | 35 ++++++++++++++++++++++ package/samplers/partial_fixed/__init__.py | 4 +++ 3 files changed, 60 insertions(+) create mode 100644 package/samplers/partial_fixed/LICENSE create mode 100644 package/samplers/partial_fixed/README.md create mode 100644 package/samplers/partial_fixed/__init__.py diff --git a/package/samplers/partial_fixed/LICENSE b/package/samplers/partial_fixed/LICENSE new file mode 100644 index 00000000..4e2b34c1 --- /dev/null +++ b/package/samplers/partial_fixed/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/partial_fixed/README.md b/package/samplers/partial_fixed/README.md new file mode 100644 index 00000000..b9ae4a1b --- /dev/null +++ b/package/samplers/partial_fixed/README.md @@ -0,0 +1,35 @@ +--- +author: 'Optuna team' +title: 'Partial Fixed Sampler' +description: 'Sampler with partially fixed parameters.' +tags: ['sampler', 'built-in'] +optuna_versions: ['3.6.1'] +license: 'MIT License' +--- + +## Class or Function Names +- PartialFixedSampler + +## 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 + + +tpe_sampler = optuna.samplers.TPESampler() +fixed_params = {"y": 0} +mod = optunahub.load_module("samplers/partial_fixed") +partial_sampler = mod.PartialFixedSampler(fixed_params, tpe_sampler) + +study = optuna.create_study(sampler=partial_sampler) +study.optimize(objective, n_trials=10) +``` + +## Others +See the [documentation](https://optuna.readthedocs.io/en/stable/reference/samplers/generated/optuna.samplers.PartialFixedSampler.html) for more details. diff --git a/package/samplers/partial_fixed/__init__.py b/package/samplers/partial_fixed/__init__.py new file mode 100644 index 00000000..97b256e8 --- /dev/null +++ b/package/samplers/partial_fixed/__init__.py @@ -0,0 +1,4 @@ +from optuna.samplers import PartialFixedSampler + + +__all__ = ["PartialFixedSampler"] From 9e1b535c5205cd55d651ead9b6640733fbf601bf Mon Sep 17 00:00:00 2001 From: Naoto Mizuno Date: Fri, 24 May 2024 15:11:02 +0900 Subject: [PATCH 5/6] 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 From f83e83cbd0b403ac65aa9e08f8f99434a0b29f6d Mon Sep 17 00:00:00 2001 From: Naoto Mizuno Date: Fri, 24 May 2024 15:12:23 +0900 Subject: [PATCH 6/6] Add requirements.txt --- package/samplers/gp/requirements.txt | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 package/samplers/gp/requirements.txt diff --git a/package/samplers/gp/requirements.txt b/package/samplers/gp/requirements.txt new file mode 100644 index 00000000..6a70935c --- /dev/null +++ b/package/samplers/gp/requirements.txt @@ -0,0 +1,2 @@ +scipy +pytorch