Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add all built-in visualization #32

Merged
merged 1 commit into from
May 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions package/visualization/plot_edf/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.
17 changes: 17 additions & 0 deletions package/visualization/plot_edf/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
author: 'Optuna team'
title: 'Empirical Distribution Function Plot'
description: 'Plot the objective value EDF (empirical distribution function) of a study.'
tags: ['visualization']
optuna_versions: ['3.6.1']
license: 'MIT License'
---

## Class or Function Names
- plot_edf

## Example
```python
mod = optunahub.load_module("visualization/plot_edf")
mod.plot_edf(study)
```
4 changes: 4 additions & 0 deletions package/visualization/plot_edf/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from optuna.visualization import plot_edf


__all__ = ["plot_edf"]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions package/visualization/plot_hypervolume_history/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.
17 changes: 17 additions & 0 deletions package/visualization/plot_hypervolume_history/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
author: 'Optuna team'
title: 'Hypervolume History Plot'
description: 'Plot hypervolume history of all trials in a study.'
tags: ['visualization']
optuna_versions: ['3.6.1']
license: 'MIT License'
---

## Class or Function Names
- plot_hypervolume_history

## Example
```python
mod = optunahub.load_module("visualization/plot_hypervolume_history")
mod.plot_hypervolume_history(study, reference_point)
```
4 changes: 4 additions & 0 deletions package/visualization/plot_hypervolume_history/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from optuna.visualization import plot_hypervolume_history


__all__ = ["plot_hypervolume_history"]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions package/visualization/plot_intermediate_values/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.
17 changes: 17 additions & 0 deletions package/visualization/plot_intermediate_values/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
author: 'Optuna team'
title: 'Intermediate Values Plot'
description: 'Plot intermediate values of all trials in a study.'
tags: ['visualization']
optuna_versions: ['3.6.1']
license: 'MIT License'
---

## Class or Function Names
- plot_intermediate_values

## Example
```python
mod = optunahub.load_module("visualization/plot_intermediate_values")
mod.plot_intermediate_values(study)
```
4 changes: 4 additions & 0 deletions package/visualization/plot_intermediate_values/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from optuna.visualization import plot_intermediate_values


__all__ = ["plot_intermediate_values"]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions package/visualization/plot_optimization_history/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.
17 changes: 17 additions & 0 deletions package/visualization/plot_optimization_history/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
author: 'Optuna team'
title: 'Optimization History Plot'
description: 'Plot optimization history of all trials in a study.'
tags: ['visualization']
optuna_versions: ['3.6.1']
license: 'MIT License'
---

## Class or Function Names
- plot_optimization_history

## Example
```python
mod = optunahub.load_module("visualization/plot_optimization_history")
mod.plot_optimization_history(study)
```
4 changes: 4 additions & 0 deletions package/visualization/plot_optimization_history/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from optuna.visualization import plot_optimization_history


__all__ = ["plot_optimization_history"]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions package/visualization/plot_parallel_coordinate/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.
17 changes: 17 additions & 0 deletions package/visualization/plot_parallel_coordinate/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
author: 'Optuna team'
title: 'Parallel Coordinate Plot'
description: 'Plot the high-dimensional parameter relationships in a study.'
tags: ['visualization']
optuna_versions: ['3.6.1']
license: 'MIT License'
---

## Class or Function Names
- plot_parallel_coordinate

## Example
```python
mod = optunahub.load_module("visualization/plot_parallel_coordinate")
mod.plot_parallel_coordinate(study)
```
4 changes: 4 additions & 0 deletions package/visualization/plot_parallel_coordinate/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from optuna.visualization import plot_parallel_coordinate


__all__ = ["plot_parallel_coordinate"]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions package/visualization/plot_param_importances/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.
17 changes: 17 additions & 0 deletions package/visualization/plot_param_importances/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
author: 'Optuna team'
title: 'Hyperparameter Importances Plot'
description: 'Plot hyperparameter importances.'
tags: ['visualization']
optuna_versions: ['3.6.1']
license: 'MIT License'
---

## Class or Function Names
- plot_param_importances

## Example
```python
mod = optunahub.load_module("visualization/plot_param_importances")
mod.plot_param_importances(study)
```
4 changes: 4 additions & 0 deletions package/visualization/plot_param_importances/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from optuna.visualization import plot_param_importances


__all__ = ["plot_param_importances"]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions package/visualization/plot_pareto_front/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.
17 changes: 17 additions & 0 deletions package/visualization/plot_pareto_front/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
author: 'Optuna team'
title: 'Pareto-front Plot'
description: 'Plot the Pareto front of a study.'
tags: ['visualization']
optuna_versions: ['3.6.1']
license: 'MIT License'
---

## Class or Function Names
- plot_pareto_front

## Example
```python
mod = optunahub.load_module("visualization/plot_pareto_front")
mod.plot_pareto_front(study)
```
4 changes: 4 additions & 0 deletions package/visualization/plot_pareto_front/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from optuna.visualization import plot_pareto_front


__all__ = ["plot_pareto_front"]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions package/visualization/plot_rank/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.
17 changes: 17 additions & 0 deletions package/visualization/plot_rank/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
author: 'Optuna team'
title: 'Rank Plot'
description: 'Plot parameter relations as scatter plots with colors indicating ranks of target value.'
tags: ['visualization']
optuna_versions: ['3.6.1']
license: 'MIT License'
---

## Class or Function Names
- plot_rank

## Example
```python
mod = optunahub.load_module("visualization/plot_rank")
mod.plot_rank(study)
```
4 changes: 4 additions & 0 deletions package/visualization/plot_rank/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from optuna.visualization import plot_rank


__all__ = ["plot_rank"]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions package/visualization/plot_slice/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.
17 changes: 17 additions & 0 deletions package/visualization/plot_slice/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
author: 'Optuna team'
title: 'Slice Plot'
description: 'Plot the parameter relationship as slice plot in a study.'
tags: ['visualization']
optuna_versions: ['3.6.1']
license: 'MIT License'
---

## Class or Function Names
- plot_slice

## Example
```python
mod = optunahub.load_module("visualization/plot_slice")
mod.plot_slice(study)
```
Loading