From ea8c90a4f1f877eac40b3ef976a3e1ebd0b9b340 Mon Sep 17 00:00:00 2001 From: Naoto Mizuno Date: Thu, 23 May 2024 14:22:49 +0900 Subject: [PATCH] Add built-in GridSampler --- package/samplers/grid_search/LICENSE | 21 ++++++++++++++ package/samplers/grid_search/README.md | 33 ++++++++++++++++++++++ package/samplers/grid_search/__init__.py | 4 +++ package/samplers/random_search/LICENSE | 21 ++++++++++++++ package/samplers/random_search/README.md | 17 +++++++++++ package/samplers/random_search/__init__.py | 4 +++ 6 files changed, 100 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 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/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"] 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..595e9ce5 --- /dev/null +++ b/package/samplers/random_search/README.md @@ -0,0 +1,17 @@ +--- +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 +Please fill in the code snippet to use the implemented feature here. + +## Others +Please fill in any other information if you have here. diff --git a/package/samplers/random_search/__init__.py b/package/samplers/random_search/__init__.py new file mode 100644 index 00000000..59718fd3 --- /dev/null +++ b/package/samplers/random_search/__init__.py @@ -0,0 +1,4 @@ +from .YOUR_TEMPLATE import YOUR_FEATURE + + +__all__ = ["YOUR_FEATURE"]