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"]