-
Notifications
You must be signed in to change notification settings - Fork 33
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 pyribs visualization #191
Conversation
Hi @nabenabe0928, I have added the visualization tools for plotting results from the CMA-MAE sampler. Would you take a look and let me know your thoughts? Thank you! |
|
||
A minimal example would be the following: | ||
|
||
```python |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nabenabe0928 Do you think I should put this visualization example in the CMA-MAE sampler documentation too?
Hey, thank you for the PR!
It's up to you, but I think it would increase the in-flow of users to this visualization module if we have the example! |
@@ -27,6 +27,9 @@ with improvement ranking, all wrapped up in a | |||
However, it is possible to implement many variations of CMA-MAE and other | |||
quality diversity algorithms using pyribs. | |||
|
|||
For visualizing the results of the `CmaMaeSampler`, note that we use the | |||
`plot_grid_archive_heatmap` function from the `plot_pyribs` plugin. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nabenabe0928 What is the correct way to link between plugins in the OptunaHub documentation? i.e., How can I provide a link to the plot_pyribs
plugin here? Similarly, in the plot_pyribs
plugin, I want to provide a link to the CmaMaeSampler
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will quickly merge this PR, so you can surely open another PR later, but basically, the URL for each package is published like this, so you could link these URLs to your package!
@btjanaka Hey sorry for the late response! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After I verify the behavior of your code, I will merge this PR!
Please link the URLs to the corresponding locations in another PR:)
@@ -27,6 +27,9 @@ with improvement ranking, all wrapped up in a | |||
However, it is possible to implement many variations of CMA-MAE and other | |||
quality diversity algorithms using pyribs. | |||
|
|||
For visualizing the results of the `CmaMaeSampler`, note that we use the | |||
`plot_grid_archive_heatmap` function from the `plot_pyribs` plugin. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will quickly merge this PR, so you can surely open another PR later, but basically, the URL for each package is published like this, so you could link these URLs to your package!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I confirmed that the example works!
I will merge this PR:)
Contributor Agreements
Please read the contributor agreements and if you agree, please click the checkbox below.
Tip
Please follow the Quick TODO list to smoothly merge your PR.
Motivation
This PR creates a plugin that provides wrappers for pyribs visualization tools. Currently, the plugin only supports the grid_archive_heatmap function from pyribs, which is sufficient for plotting the results from CmaMaeSampler.
Description of the changes
visualization/plot_pyribs
plot_grid_archive_heatmap
, which is a wrapper aroundribs.visualize.grid_archive_heatmap
from pyribs.TODO List towards PR Merge
Please remove this section if this PR is not an addition of a new package.
Otherwise, please check the following TODO list:
./template/
to create your package<COPYRIGHT HOLDER>
inLICENSE
of your package with your nameREADME.md
in your package__init__.py
from __future__ import annotations
at the head of any Python files that include typing to support older Python versionsREADME.md
README.md