<h1 align="center">fBench</h1>
<p align="center">
<a href="https://pypi.org/project/fbench"><img alt="pypi" src="https://img.shields.io/pypi/v/fbench"></a>
<a href="https://readthedocs.org/projects/fbench/?badge=latest"><img alt="docs" src="https://readthedocs.org/projects/fbench/badge/?version=latest"></a>
<a href="https://github.com/estripling/fbench/actions/workflows/ci.yml"><img alt="ci status" src="https://github.com/estripling/fbench/actions/workflows/ci.yml/badge.svg?branch=main"></a>
<a href="https://codecov.io/gh/estripling/fbench"><img alt="coverage" src="https://codecov.io/github/estripling/fbench/coverage.svg?branch=main"></a>
<a href="https://github.com/estripling/fbench/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/pypi/l/fbench"></a>
</p>
## About
A collection of benchmark functions:
- [Documentation](https://fbench.readthedocs.io/en/stable/index.html)
- [Overview of fBench functions](https://fbench.readthedocs.io/en/stable/fBench-functions.html)
- [Example usage](https://fbench.readthedocs.io/en/stable/example.html)
- [API Reference](https://fbench.readthedocs.io/en/stable/autoapi/fbench/index.html)
## Installation
`fbench` is available on [PyPI](https://pypi.org/project/fbench/) for Python 3.8+:
```console
pip install fbench
```
## Examples
The [`ackley`](https://fbench.readthedocs.io/en/stable/autoapi/fbench/index.html#fbench.ackley) function:
```python
>>> import fbench
>>> round(fbench.ackley([1, 1]), 4)
3.6254
```
Visualize function with [`FunctionPlotter`](https://fbench.readthedocs.io/en/stable/autoapi/fbench/viz/index.html#fbench.viz.FunctionPlotter):
```python
>>> import matplotlib.pyplot as plt
>>> plotter = fbench.viz.FunctionPlotter(func=fbench.ackley, bounds=[(-5, 5)] * 2)
>>> plotter.plot()
>>> plt.show()
```
<p align="left">
<img src="https://raw.githubusercontent.com/estripling/fbench/main/images/readme-ackley.png" width="800" alt="Ackley function.">
</p>
## Contributing to fBench
Your contribution is greatly appreciated!
See the following links to help you get started:
- [Contributing Guide](https://fbench.readthedocs.io/en/latest/contributing.html)
- [Developer Guide](https://fbench.readthedocs.io/en/latest/developers.html)
- [Contributor Code of Conduct](https://fbench.readthedocs.io/en/latest/conduct.html)
## License
`fbench` was created by fBench Developers.
It is licensed under the terms of the BSD 3-Clause license.
Raw data
{
"_id": null,
"home_page": "https://github.com/estripling/fbench",
"name": "fbench",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "fbench",
"author": "fBench Developers",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/6f/7d/f6bd600a8a734279c7411155a6a006efbf632b9c6b4ee233878ae4734474/fbench-1.0.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">fBench</h1>\n\n<p align=\"center\">\n<a href=\"https://pypi.org/project/fbench\"><img alt=\"pypi\" src=\"https://img.shields.io/pypi/v/fbench\"></a>\n<a href=\"https://readthedocs.org/projects/fbench/?badge=latest\"><img alt=\"docs\" src=\"https://readthedocs.org/projects/fbench/badge/?version=latest\"></a>\n<a href=\"https://github.com/estripling/fbench/actions/workflows/ci.yml\"><img alt=\"ci status\" src=\"https://github.com/estripling/fbench/actions/workflows/ci.yml/badge.svg?branch=main\"></a>\n<a href=\"https://codecov.io/gh/estripling/fbench\"><img alt=\"coverage\" src=\"https://codecov.io/github/estripling/fbench/coverage.svg?branch=main\"></a>\n<a href=\"https://github.com/estripling/fbench/blob/main/LICENSE\"><img alt=\"license\" src=\"https://img.shields.io/pypi/l/fbench\"></a>\n</p>\n\n## About\n\nA collection of benchmark functions:\n\n- [Documentation](https://fbench.readthedocs.io/en/stable/index.html)\n- [Overview of fBench functions](https://fbench.readthedocs.io/en/stable/fBench-functions.html)\n- [Example usage](https://fbench.readthedocs.io/en/stable/example.html)\n- [API Reference](https://fbench.readthedocs.io/en/stable/autoapi/fbench/index.html)\n\n## Installation\n\n`fbench` is available on [PyPI](https://pypi.org/project/fbench/) for Python 3.8+:\n\n```console\npip install fbench\n```\n\n## Examples\n\nThe [`ackley`](https://fbench.readthedocs.io/en/stable/autoapi/fbench/index.html#fbench.ackley) function:\n\n```python\n>>> import fbench\n>>> round(fbench.ackley([1, 1]), 4)\n3.6254\n```\n\nVisualize function with [`FunctionPlotter`](https://fbench.readthedocs.io/en/stable/autoapi/fbench/viz/index.html#fbench.viz.FunctionPlotter):\n\n```python\n>>> import matplotlib.pyplot as plt\n>>> plotter = fbench.viz.FunctionPlotter(func=fbench.ackley, bounds=[(-5, 5)] * 2)\n>>> plotter.plot()\n>>> plt.show()\n```\n<p align=\"left\">\n<img src=\"https://raw.githubusercontent.com/estripling/fbench/main/images/readme-ackley.png\" width=\"800\" alt=\"Ackley function.\">\n</p>\n\n## Contributing to fBench\n\nYour contribution is greatly appreciated!\nSee the following links to help you get started:\n\n- [Contributing Guide](https://fbench.readthedocs.io/en/latest/contributing.html)\n- [Developer Guide](https://fbench.readthedocs.io/en/latest/developers.html)\n- [Contributor Code of Conduct](https://fbench.readthedocs.io/en/latest/conduct.html)\n\n## License\n\n`fbench` was created by fBench Developers.\nIt is licensed under the terms of the BSD 3-Clause license.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "A collection of benchmark functions.",
"version": "1.0.1",
"project_urls": {
"Documentation": "https://fbench.readthedocs.io/en/stable/",
"Homepage": "https://github.com/estripling/fbench",
"Repository": "https://github.com/estripling/fbench"
},
"split_keywords": [
"fbench"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b8faf5989c6322d0f52a83566de39a9b6d8da5812228246a4c3d71424ae9411e",
"md5": "7792fcdde4674187fbeefa45db1052db",
"sha256": "fc20ba6565fb5e6cd509d6ce00277ec0c0e472edcf14d9d26e8e264aff16091e"
},
"downloads": -1,
"filename": "fbench-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7792fcdde4674187fbeefa45db1052db",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 12290,
"upload_time": "2023-05-18T19:13:30",
"upload_time_iso_8601": "2023-05-18T19:13:30.740347Z",
"url": "https://files.pythonhosted.org/packages/b8/fa/f5989c6322d0f52a83566de39a9b6d8da5812228246a4c3d71424ae9411e/fbench-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6f7df6bd600a8a734279c7411155a6a006efbf632b9c6b4ee233878ae4734474",
"md5": "73906dcdc5f872345ffc6303f372cd1b",
"sha256": "322c0435c52158882fa61ddc903c4401c465b71f4aaebd3868c7217f5367f5d9"
},
"downloads": -1,
"filename": "fbench-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "73906dcdc5f872345ffc6303f372cd1b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 11372,
"upload_time": "2023-05-18T19:13:32",
"upload_time_iso_8601": "2023-05-18T19:13:32.403204Z",
"url": "https://files.pythonhosted.org/packages/6f/7d/f6bd600a8a734279c7411155a6a006efbf632b9c6b4ee233878ae4734474/fbench-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-18 19:13:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "estripling",
"github_project": "fbench",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fbench"
}
JSON
