Merge branch 'main' into nsga2-sampler

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.

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.

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.

package/samplers/cmaes/__init__.py

@@ -0,0 +1,4 @@
+from optuna.samplers import CmaEsSampler
+
+
+__all__ = ["CmaEsSampler"]

package/samplers/cmaes/requirements.txt

@@ -0,0 +1 @@
+cmaes

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.

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.

package/samplers/gp/__init__.py

@@ -0,0 +1,4 @@
+from optuna.samplers import GPSampler
+
+
+__all__ = ["GPSampler"]

package/samplers/gp/requirements.txt

@@ -0,0 +1,2 @@
+scipy
+pytorch

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.

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.

package/samplers/partial_fixed/__init__.py

@@ -0,0 +1,4 @@
+from optuna.samplers import PartialFixedSampler
+
+
+__all__ = ["PartialFixedSampler"]