From 1d9b10c2aa7ad601d5cbc64d944c0c48f36752cb Mon Sep 17 00:00:00 2001 From: y0z Date: Thu, 23 May 2024 13:33:09 +0900 Subject: [PATCH 1/5] Fix hyperlink to contributor agreement --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8ec7113e..69de762d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ ## Contributor Agreements -Please read the [contributor agreements](CONTRIBUTING.md#contributor-agreements) and if you agree, please click the checkbox below. +Please read the [contributor agreements](https://github.com/optuna/optunahub-registry/blob/main/CONTRIBUTING.md#contributor-agreements) and if you agree, please click the checkbox below. - [ ] I agree to the contributor agreements. From 9c2ff810d5df4f87f0aa934e45ab0f58535975eb Mon Sep 17 00:00:00 2001 From: y0z Date: Thu, 23 May 2024 14:10:06 +0900 Subject: [PATCH 2/5] Fix license template --- template/LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/template/LICENSE b/template/LICENSE index 4e2b34c1..8258caf5 100644 --- a/template/LICENSE +++ b/template/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 Preferred Networks, Inc. +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 From 1d8045727cd6802ef83ce881814053747610a65d Mon Sep 17 00:00:00 2001 From: Naoto Mizuno Date: Thu, 23 May 2024 14:29:34 +0900 Subject: [PATCH 3/5] Add built-in RandomSampler --- package/samplers/random_search/LICENSE | 21 ++++++++++++++ package/samplers/random_search/README.md | 32 ++++++++++++++++++++++ package/samplers/random_search/__init__.py | 4 +++ 3 files changed, 57 insertions(+) create mode 100644 package/samplers/random_search/LICENSE create mode 100644 package/samplers/random_search/README.md create mode 100644 package/samplers/random_search/__init__.py diff --git a/package/samplers/random_search/LICENSE b/package/samplers/random_search/LICENSE new file mode 100644 index 00000000..4e2b34c1 --- /dev/null +++ b/package/samplers/random_search/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/random_search/README.md b/package/samplers/random_search/README.md new file mode 100644 index 00000000..a5e97792 --- /dev/null +++ b/package/samplers/random_search/README.md @@ -0,0 +1,32 @@ +--- +author: 'Optuna team' +title: 'Random Search' +description: 'Sampler using random sampling.' +tags: ['sampler', 'built-in'] +optuna_versions: ['3.6.1'] +license: 'MIT License' +--- + +## Class or Function Names +- RandomSampler + +## Example +```python +import optuna +import optunahub + + +def objective(trial): + x = trial.suggest_float("x", -5, 5) + return x**2 + + +mod = optunahub.load_module("samplers/random_search") +sampler = mod.RandomSampler() +study = optuna.create_study(sampler=sampler) +study.optimize(objective, n_trials=10) +``` + +## Others +See the [documentation](https://optuna.readthedocs.io/en/stable/reference/samplers/generated/optuna.samplers.RandomSampler.html) for more details. + diff --git a/package/samplers/random_search/__init__.py b/package/samplers/random_search/__init__.py new file mode 100644 index 00000000..e6aa2bf6 --- /dev/null +++ b/package/samplers/random_search/__init__.py @@ -0,0 +1,4 @@ +from optuna.samplers import RandomSampler + + +__all__ = ["RandomSampler"] From a708af509d432ebffa08e8a0f0da20ec76834502 Mon Sep 17 00:00:00 2001 From: Naoto Mizuno Date: Thu, 23 May 2024 14:33:49 +0900 Subject: [PATCH 4/5] Add built-in GridSampler --- package/samplers/grid_search/LICENSE | 21 +++++++++++++++ package/samplers/grid_search/README.md | 33 ++++++++++++++++++++++++ package/samplers/grid_search/__init__.py | 4 +++ 3 files changed, 58 insertions(+) create mode 100644 package/samplers/grid_search/LICENSE create mode 100644 package/samplers/grid_search/README.md create mode 100644 package/samplers/grid_search/__init__.py diff --git a/package/samplers/grid_search/LICENSE b/package/samplers/grid_search/LICENSE new file mode 100644 index 00000000..4e2b34c1 --- /dev/null +++ b/package/samplers/grid_search/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/grid_search/README.md b/package/samplers/grid_search/README.md new file mode 100644 index 00000000..82b628c3 --- /dev/null +++ b/package/samplers/grid_search/README.md @@ -0,0 +1,33 @@ +--- +author: 'Optuna team' +title: 'Grid Search' +description: 'Sampler using grid search.' +tags: ['sampler', 'built-in'] +optuna_versions: ['3.6.1'] +license: 'MIT License' +--- + +## Class or Function Names +- GridSampler + +## Example +```python +import optuna +import optunahub + + +def objective(trial): + x = trial.suggest_float("x", -100, 100) + y = trial.suggest_int("y", -100, 100) + return x**2 + y**2 + + +search_space = {"x": [-50, 0, 50], "y": [-99, 0, 99]} +mod = optunahub.load_module("samplers/grid_search") +sampler = mod.GridSampler(search_space) +study = optuna.create_study(sampler=sampler) +study.optimize(objective) +``` + +## Others +See the [documentation](https://optuna.readthedocs.io/en/stable/reference/samplers/generated/optuna.samplers.GridSampler.html) for more details. diff --git a/package/samplers/grid_search/__init__.py b/package/samplers/grid_search/__init__.py new file mode 100644 index 00000000..cde1ea87 --- /dev/null +++ b/package/samplers/grid_search/__init__.py @@ -0,0 +1,4 @@ +from optuna.samplers import GridSampler + + +__all__ = ["GridSampler"] From a3c77f2ed537af9eb84904f77432d6f7abaad64d Mon Sep 17 00:00:00 2001 From: Naoto Mizuno Date: Thu, 23 May 2024 16:34:11 +0900 Subject: [PATCH 5/5] Add built-in TPESampler --- package/samplers/tpe/LICENSE | 21 +++++++++++++++++++++ package/samplers/tpe/README.md | 31 +++++++++++++++++++++++++++++++ package/samplers/tpe/__init__.py | 4 ++++ 3 files changed, 56 insertions(+) create mode 100644 package/samplers/tpe/LICENSE create mode 100644 package/samplers/tpe/README.md create mode 100644 package/samplers/tpe/__init__.py diff --git a/package/samplers/tpe/LICENSE b/package/samplers/tpe/LICENSE new file mode 100644 index 00000000..4e2b34c1 --- /dev/null +++ b/package/samplers/tpe/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/tpe/README.md b/package/samplers/tpe/README.md new file mode 100644 index 00000000..63986bbd --- /dev/null +++ b/package/samplers/tpe/README.md @@ -0,0 +1,31 @@ +--- +author: 'Optuna team' +title: 'TPE Sampler' +description: 'Sampler using TPE (Tree-structured Parzen Estimator) algorithm.' +tags: ['sampler', 'built-in'] +optuna_versions: ['3.6.1'] +license: 'MIT License' +--- + +## Class or Function Names +- TPESampler + +## Example +```python +import optuna +import optunahub + + +def objective(trial): + x = trial.suggest_float("x", -10, 10) + return x**2 + + +mod = optunahub.load_module("samplers/tpe") +sampler = mod.TPESampler() +study = optuna.create_study(sampler=sampler) +study.optimize(objective, n_trials=10) +``` + +## Others +See the [documentation](https://optuna.readthedocs.io/en/stable/reference/samplers/generated/optuna.samplers.TPESampler.html) for more details. diff --git a/package/samplers/tpe/__init__.py b/package/samplers/tpe/__init__.py new file mode 100644 index 00000000..d73d239b --- /dev/null +++ b/package/samplers/tpe/__init__.py @@ -0,0 +1,4 @@ +from optuna.samplers import TPESampler + + +__all__ = ["TPESampler"]