From 32917f3b008687d7c4aaa7df3a8827d244cecff4 Mon Sep 17 00:00:00 2001 From: y0z Date: Thu, 29 Aug 2024 11:23:42 +0900 Subject: [PATCH 1/6] Update README.md --- README.md | 50 +++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 39 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ef3b71f..e36fa10 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -OptunaHub +![OptunaHub](https://github.com/user-attachments/assets/f93874ee-2a37-45e6-b1a5-125b8689f151) +OptunaHub: Feature-sharing platform for Optuna ================== [![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org) @@ -7,22 +8,34 @@ OptunaHub [![Codecov](https://codecov.io/gh/optuna/optunahub/branch/main/graph/badge.svg)](https://codecov.io/gh/optuna/optunahub) -Python Library to use packages published in [OptunaHub](https://hub.optuna.org/). -If you would like to register your package in OptunaHub, please contribute by creating a pull request to [the optunahub-registry repository](https://github.com/optuna/optunahub-registry). +:link: [**Website**](https://hub.optuna.org/) +| :page_with_curl: [**Docs**](https://optuna.github.io/optunahub/) +| [**Twitter**](https://twitter.com/OptunaAutoML) +| [**LinkedIn**](https://www.linkedin.com/showcase/optuna/) +| [**Medium**](https://medium.com/optuna) -# Install -Install `optunahub` package. +[*OptunaHub*](https://hub.optuna.org/) is a platform for sharing algorithms in [Optuna](https://optuna.org/), a powerful and flexible hyperparameter optimization framework. OptunaHub provides implementations of state-of-the-art optimization algorithms and visualization of optimization results for analysis. You can also publish your algorithm implementation on the platform and make it available to Optuna users around the world. + + +This is the repository of the optunahub Python Library to use packages published in [OptunaHub](https://hub.optuna.org/). If you would like to register your package in OptunaHub, please contribute by creating a pull request to [the optunahub-registry repository](https://github.com/optuna/optunahub-registry). + + +## :loudspeaker: News + +* **Jul 16, 2024**: We posted an article [Announcing OptunaHub 0.1.0-β](https://medium.com/optuna/announcing-optunahub-0-1-0-%CE%B2-69b35bb3e95e) that describes what is, how to use, and how to contribute to OptunaHub. + +## Installation + +Optuna is available at [the Python Package Index](https://pypi.org/project/optunahub/). + ```sh pip install optunahub ``` -# Documentation +## Example -- [OptunaHub documentation](https://optuna.github.io/optunahub/) - - -# Example +You only need to search for the desired function on [the OptunaHub website](https://hub.optuna.org/) and call the [optunahub.load_module](https://optuna.github.io/optunahub/) function in your code to incorporate it. ```python import optuna @@ -40,5 +53,20 @@ study = optuna.create_study(sampler=mod.SimulatedAnnealingSampler()) study.optimize(objective, n_trials=20) print(study.best_trial.value, study.best_trial.params) - ``` + +## Contribution + +Any contributions to OptunaHub are more than welcome! + +OptunaHub is composed of the following three related repositories. Please contribute to the appropriate repository for your purposes. +- [optunahub](https://github.com/optuna/optunahub) (*this repository*) + - The python library to use OptunaHub. If you find issues and/or bugs in the optunahub library, please report it here via [Github issues](https://github.com/optuna/optunahub/issues). +- [optunahub-registry](https://github.com/optuna/optunahub-registry/) + - The registry of the OptunaHub packages. If you are interested in registering your package with OptunaHub, please contribute to this repository. For general guidelines on how to contribute to the repository, take a look at [CONTRIBUTING.md](https://github.com/optuna/optunahub-registry/blob/main/CONTRIBUTING.md). +- [optunahub-web](https://github.com/optuna/optunahub-web/) + - The web frontend for OptunaHub. If you find issues and/or bugs on the website, please report it here via [GitHub issues](https://github.com/optuna/optunahub-web/issues). + +## License + +MIT License (see [LICENSE](https://github.com/optuna/optunahub/blob/main/LICENSE)). \ No newline at end of file From eb4d075a4f2ae84beee36ff57f6fb26c29ae4363 Mon Sep 17 00:00:00 2001 From: Yoshihiko Ozaki <30489874+y0z@users.noreply.github.com> Date: Thu, 29 Aug 2024 11:26:40 +0900 Subject: [PATCH 2/6] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e36fa10..1799c12 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![OptunaHub](https://github.com/user-attachments/assets/f93874ee-2a37-45e6-b1a5-125b8689f151) +![OptunaHub](https://github.com/user-attachments/assets/c5a53304-8f62-4c26-8464-9b338dd3ad97) OptunaHub: Feature-sharing platform for Optuna ================== @@ -69,4 +69,4 @@ OptunaHub is composed of the following three related repositories. Please contri ## License -MIT License (see [LICENSE](https://github.com/optuna/optunahub/blob/main/LICENSE)). \ No newline at end of file +MIT License (see [LICENSE](https://github.com/optuna/optunahub/blob/main/LICENSE)). From 270ab554265602fd2dcded8f425ad72698c8535d Mon Sep 17 00:00:00 2001 From: Yoshihiko Ozaki <30489874+y0z@users.noreply.github.com> Date: Thu, 29 Aug 2024 11:30:35 +0900 Subject: [PATCH 3/6] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1799c12..394f29a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ -![OptunaHub](https://github.com/user-attachments/assets/c5a53304-8f62-4c26-8464-9b338dd3ad97) OptunaHub: Feature-sharing platform for Optuna ================== +![OptunaHub](https://github.com/user-attachments/assets/c5a53304-8f62-4c26-8464-9b338dd3ad97) + + [![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org) [![pypi](https://img.shields.io/pypi/v/optunahub.svg)](https://pypi.python.org/pypi/optunahub) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/optuna/optunahub) @@ -20,7 +22,6 @@ OptunaHub: Feature-sharing platform for Optuna This is the repository of the optunahub Python Library to use packages published in [OptunaHub](https://hub.optuna.org/). If you would like to register your package in OptunaHub, please contribute by creating a pull request to [the optunahub-registry repository](https://github.com/optuna/optunahub-registry). - ## :loudspeaker: News * **Jul 16, 2024**: We posted an article [Announcing OptunaHub 0.1.0-β](https://medium.com/optuna/announcing-optunahub-0-1-0-%CE%B2-69b35bb3e95e) that describes what is, how to use, and how to contribute to OptunaHub. From 67ab4a0e6ade6d25b28aff4298b40a282dfeb7e5 Mon Sep 17 00:00:00 2001 From: y0z Date: Thu, 29 Aug 2024 11:44:31 +0900 Subject: [PATCH 4/6] Update links --- README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1799c12..47dd3c1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -![OptunaHub](https://github.com/user-attachments/assets/c5a53304-8f62-4c26-8464-9b338dd3ad97) OptunaHub: Feature-sharing platform for Optuna ================== @@ -8,19 +7,17 @@ OptunaHub: Feature-sharing platform for Optuna [![Codecov](https://codecov.io/gh/optuna/optunahub/branch/main/graph/badge.svg)](https://codecov.io/gh/optuna/optunahub) -:link: [**Website**](https://hub.optuna.org/) +:link: [**OptunaHub**](https://hub.optuna.org/) | :page_with_curl: [**Docs**](https://optuna.github.io/optunahub/) -| [**Twitter**](https://twitter.com/OptunaAutoML) -| [**LinkedIn**](https://www.linkedin.com/showcase/optuna/) -| [**Medium**](https://medium.com/optuna) +| [**Optuna.org**](https://optuna.org/) +![OptunaHub](https://github.com/user-attachments/assets/c5a53304-8f62-4c26-8464-9b338dd3ad97) [*OptunaHub*](https://hub.optuna.org/) is a platform for sharing algorithms in [Optuna](https://optuna.org/), a powerful and flexible hyperparameter optimization framework. OptunaHub provides implementations of state-of-the-art optimization algorithms and visualization of optimization results for analysis. You can also publish your algorithm implementation on the platform and make it available to Optuna users around the world. This is the repository of the optunahub Python Library to use packages published in [OptunaHub](https://hub.optuna.org/). If you would like to register your package in OptunaHub, please contribute by creating a pull request to [the optunahub-registry repository](https://github.com/optuna/optunahub-registry). - ## :loudspeaker: News * **Jul 16, 2024**: We posted an article [Announcing OptunaHub 0.1.0-β](https://medium.com/optuna/announcing-optunahub-0-1-0-%CE%B2-69b35bb3e95e) that describes what is, how to use, and how to contribute to OptunaHub. From 6de332fe53e2059662f58b94ec66b1453d88dc20 Mon Sep 17 00:00:00 2001 From: y0z Date: Thu, 29 Aug 2024 11:45:29 +0900 Subject: [PATCH 5/6] Fix --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 594cf5e..0987df5 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,6 @@ OptunaHub: Feature-sharing platform for Optuna | :page_with_curl: [**Docs**](https://optuna.github.io/optunahub/) | [**Optuna.org**](https://optuna.org/) -![OptunaHub](https://github.com/user-attachments/assets/c5a53304-8f62-4c26-8464-9b338dd3ad97) - [*OptunaHub*](https://hub.optuna.org/) is a platform for sharing algorithms in [Optuna](https://optuna.org/), a powerful and flexible hyperparameter optimization framework. OptunaHub provides implementations of state-of-the-art optimization algorithms and visualization of optimization results for analysis. You can also publish your algorithm implementation on the platform and make it available to Optuna users around the world. From 3c486b75974c0639c46e8ead4d68bcd1a75e8f04 Mon Sep 17 00:00:00 2001 From: Yoshihiko Ozaki <30489874+y0z@users.noreply.github.com> Date: Thu, 29 Aug 2024 12:03:37 +0900 Subject: [PATCH 6/6] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 0987df5..b220c50 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ OptunaHub: Feature-sharing platform for Optuna ================== -![OptunaHub](https://github.com/user-attachments/assets/c5a53304-8f62-4c26-8464-9b338dd3ad97) - +![OptunaHub](https://github.com/user-attachments/assets/ee24b6eb-a431-4e02-ae52-c2538ffe01ee) [![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org) [![pypi](https://img.shields.io/pypi/v/optunahub.svg)](https://pypi.python.org/pypi/optunahub)