Skip to content

Commit

Permalink
Add built-in NSGAIIISampler
Browse files Browse the repository at this point in the history
  • Loading branch information
eukaryo committed May 24, 2024
1 parent f789645 commit 4ca11b2
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 0 deletions.
21 changes: 21 additions & 0 deletions package/samplers/nsgaiii/LICENSE
Original file line number Diff line number Diff line change
@@ -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.
32 changes: 32 additions & 0 deletions package/samplers/nsgaiii/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
author: 'Optuna team'
title: 'NSGAIII Search'
description: 'Sampler using NSGAIII algotithm.'
tags: ['sampler', 'built-in']
optuna_versions: ['3.6.1']
license: 'MIT License'
---

## Class or Function Names
- NSGAIIISampler

## Example
```python
import optuna
import optunahub


def objective(trial):
x = trial.suggest_float("x", -5, 5)
return x**2


mod = optunahub.load_module("samplers/nsgaiii")
sampler = mod.NSGAIIISampler()
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.NSGAIIISampler.html) for more details.

4 changes: 4 additions & 0 deletions package/samplers/nsgaiii/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from optuna.samplers import NSGAIIISampler


__all__ = ["NSGAIIISampler"]

0 comments on commit 4ca11b2

Please sign in to comment.