optunahub


Nameoptunahub JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryOptunaHub
upload_time2025-01-20 06:09:22
maintainerNone
docs_urlNone
authorOptuna team
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            OptunaHub: Feature-sharing platform for Optuna
==================

![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)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/optuna/optunahub)
[![Codecov](https://codecov.io/gh/optuna/optunahub/branch/main/graph/badge.svg)](https://codecov.io/gh/optuna/optunahub)


:link: [**OptunaHub**](https://hub.optuna.org/)
| :page_with_curl: [**Docs**](https://optuna.github.io/optunahub/)
| [**Optuna.org**](https://optuna.org/)

[*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

* **Nov 6, 2024**: A new article [AutoSampler: Automatic Selection of Optimization Algorithms in Optuna](https://medium.com/optuna/autosampler-automatic-selection-of-optimization-algorithms-in-optuna-1443875fd8f9) has been published.
* **Oct 21, 2024**: We posted [an article](https://medium.com/optuna/an-introduction-to-moea-d-and-examples-of-multi-objective-optimization-comparisons-8630565a4e89) introducing [MOEA/D](https://hub.optuna.org/samplers/moead/) and an example comparison with other optimization methods.
* **Aug 30, 2024**: New Medium article "[OptunaHub, a Feature-Sharing Platform for Optuna, Now Available in Official Release!](https://medium.com/optuna/optunahub-a-feature-sharing-platform-for-optuna-now-available-in-official-release-4b99efe9934d)" was published!
* **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
```

## 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
import optunahub


def objective(trial: optuna.Trial) -> float:
  x = trial.suggest_float("x", -5, 5)
  y = trial.suggest_float("y", -5, 5)
  return x**2 + y**2


module = optunahub.load_module(package="samplers/auto_sampler")
study = optuna.create_study(sampler=module.AutoSampler())
study.optimize(objective, n_trials=10)

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)).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "optunahub",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Optuna team",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/29/7c/9cdcb1d31dd6bee9ed664863ba8bf4c3abb57f249e15cc7cdbee239b7b35/optunahub-0.2.0.tar.gz",
    "platform": null,
    "description": "OptunaHub: Feature-sharing platform for Optuna\n==================\n\n![OptunaHub](https://github.com/user-attachments/assets/ee24b6eb-a431-4e02-ae52-c2538ffe01ee)\n\n[![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)\n[![pypi](https://img.shields.io/pypi/v/optunahub.svg)](https://pypi.python.org/pypi/optunahub)\n[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/optuna/optunahub)\n[![Codecov](https://codecov.io/gh/optuna/optunahub/branch/main/graph/badge.svg)](https://codecov.io/gh/optuna/optunahub)\n\n\n:link: [**OptunaHub**](https://hub.optuna.org/)\n| :page_with_curl: [**Docs**](https://optuna.github.io/optunahub/)\n| [**Optuna.org**](https://optuna.org/)\n\n[*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.\n\n\nThis 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).\n\n## :loudspeaker: News\n\n* **Nov 6, 2024**: A new article [AutoSampler: Automatic Selection of Optimization Algorithms in Optuna](https://medium.com/optuna/autosampler-automatic-selection-of-optimization-algorithms-in-optuna-1443875fd8f9) has been published.\n* **Oct 21, 2024**: We posted [an article](https://medium.com/optuna/an-introduction-to-moea-d-and-examples-of-multi-objective-optimization-comparisons-8630565a4e89) introducing [MOEA/D](https://hub.optuna.org/samplers/moead/) and an example comparison with other optimization methods.\n* **Aug 30, 2024**: New Medium article \"[OptunaHub, a Feature-Sharing Platform for Optuna, Now Available in Official Release!](https://medium.com/optuna/optunahub-a-feature-sharing-platform-for-optuna-now-available-in-official-release-4b99efe9934d)\" was published!\n* **Jul 16, 2024**: We posted an article [Announcing OptunaHub 0.1.0-\u03b2](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.\n\n## Installation\n\nOptuna is available at [the Python Package Index](https://pypi.org/project/optunahub/).\n\n```sh\npip install optunahub\n```\n\n## Example\n\nYou 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.\n\n```python\nimport optuna\nimport optunahub\n\n\ndef objective(trial: optuna.Trial) -> float:\n  x = trial.suggest_float(\"x\", -5, 5)\n  y = trial.suggest_float(\"y\", -5, 5)\n  return x**2 + y**2\n\n\nmodule = optunahub.load_module(package=\"samplers/auto_sampler\")\nstudy = optuna.create_study(sampler=module.AutoSampler())\nstudy.optimize(objective, n_trials=10)\n\nprint(study.best_trial.value, study.best_trial.params)\n```\n\n## Contribution\n\nAny contributions to OptunaHub are more than welcome!\n\nOptunaHub is composed of the following three related repositories. Please contribute to the appropriate repository for your purposes.\n- [optunahub](https://github.com/optuna/optunahub) (*this repository*)\n    - 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).\n- [optunahub-registry](https://github.com/optuna/optunahub-registry/)\n    - 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).\n- [optunahub-web](https://github.com/optuna/optunahub-web/)\n    - 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).\n\n## License\n\nMIT License (see [LICENSE](https://github.com/optuna/optunahub/blob/main/LICENSE)).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "OptunaHub",
    "version": "0.2.0",
    "project_urls": {
        "bugtracker": "https://github.com/optuna/optunahub/issues",
        "documentation": "https://optuna.github.io/optunahub/",
        "homepage": "https://hub.optuna.org/",
        "repository": "https://github.com/optuna/optunahub"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f9f0b825bd53ccfd8d0b93ddddb323e2db609e1f957cc0bf9267db4e6422f2c1",
                "md5": "4c64004b562207bb56db3bf8f4dd225c",
                "sha256": "e57b7de97227cb5eadf03369bcb30e7d72c20cc863f04d9b3a8fc1e6e0c9a92d"
            },
            "downloads": -1,
            "filename": "optunahub-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4c64004b562207bb56db3bf8f4dd225c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 11399,
            "upload_time": "2025-01-20T06:09:21",
            "upload_time_iso_8601": "2025-01-20T06:09:21.482398Z",
            "url": "https://files.pythonhosted.org/packages/f9/f0/b825bd53ccfd8d0b93ddddb323e2db609e1f957cc0bf9267db4e6422f2c1/optunahub-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "297c9cdcb1d31dd6bee9ed664863ba8bf4c3abb57f249e15cc7cdbee239b7b35",
                "md5": "1b192d6e2620771329fe380e8066beed",
                "sha256": "6fc08afcdb9ca35dc1badfa4a8152c7645f3c25f125d011e08ac897f13152d0a"
            },
            "downloads": -1,
            "filename": "optunahub-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1b192d6e2620771329fe380e8066beed",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 12462,
            "upload_time": "2025-01-20T06:09:22",
            "upload_time_iso_8601": "2025-01-20T06:09:22.542597Z",
            "url": "https://files.pythonhosted.org/packages/29/7c/9cdcb1d31dd6bee9ed664863ba8bf4c3abb57f249e15cc7cdbee239b7b35/optunahub-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-20 06:09:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "optuna",
    "github_project": "optunahub",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "optunahub"
}
        
Elapsed time: 0.75176s