Skip to content

Commit 34ee140

Browse files
Merge pull request #62 from y0z/feature/update-readme
Update README.md
2 parents f66c933 + 3c486b7 commit 34ee140

File tree

1 file changed

+36
-11
lines changed

1 file changed

+36
-11
lines changed

README.md

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,38 @@
1-
OptunaHub
1+
OptunaHub: Feature-sharing platform for Optuna
22
==================
33

4+
![OptunaHub](https://github.com/user-attachments/assets/ee24b6eb-a431-4e02-ae52-c2538ffe01ee)
5+
46
[![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)
57
[![pypi](https://img.shields.io/pypi/v/optunahub.svg)](https://pypi.python.org/pypi/optunahub)
68
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/optuna/optunahub)
79
[![Codecov](https://codecov.io/gh/optuna/optunahub/branch/main/graph/badge.svg)](https://codecov.io/gh/optuna/optunahub)
810

911

10-
Python Library to use packages published in [OptunaHub](https://hub.optuna.org/).
11-
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).
12+
:link: [**OptunaHub**](https://hub.optuna.org/)
13+
| :page_with_curl: [**Docs**](https://optuna.github.io/optunahub/)
14+
| [**Optuna.org**](https://optuna.org/)
15+
16+
[*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.
17+
18+
19+
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).
1220

13-
# Install
21+
## :loudspeaker: News
22+
23+
* **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.
24+
25+
## Installation
26+
27+
Optuna is available at [the Python Package Index](https://pypi.org/project/optunahub/).
1428

15-
Install `optunahub` package.
1629
```sh
1730
pip install optunahub
1831
```
1932

20-
# Documentation
21-
22-
- [OptunaHub documentation](https://optuna.github.io/optunahub/)
33+
## Example
2334

24-
25-
# Example
35+
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.
2636

2737
```python
2838
import optuna
@@ -40,5 +50,20 @@ study = optuna.create_study(sampler=mod.SimulatedAnnealingSampler())
4050
study.optimize(objective, n_trials=20)
4151

4252
print(study.best_trial.value, study.best_trial.params)
43-
4453
```
54+
55+
## Contribution
56+
57+
Any contributions to OptunaHub are more than welcome!
58+
59+
OptunaHub is composed of the following three related repositories. Please contribute to the appropriate repository for your purposes.
60+
- [optunahub](https://github.com/optuna/optunahub) (*this repository*)
61+
- 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).
62+
- [optunahub-registry](https://github.com/optuna/optunahub-registry/)
63+
- 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).
64+
- [optunahub-web](https://github.com/optuna/optunahub-web/)
65+
- 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).
66+
67+
## License
68+
69+
MIT License (see [LICENSE](https://github.com/optuna/optunahub/blob/main/LICENSE)).

0 commit comments

Comments
 (0)