Metadata-Version: 2.1
Name: speed-benchmark
Version: 1.1.0
Summary: A generic speed benchmark library.
Author-email: shenmishajing <shenmishajing@gmail.com>
License: MIT License
Project-URL: Homepage, https://github.com/shenmishajing/speed_benchmark
Project-URL: Repository, https://github.com/shenmishajing/speed_benchmark
Project-URL: Documentation, https://speed-benchmark.readthedocs.io
Project-URL: Issues, https://github.com/shenmishajing/speed_benchmark/issues
Project-URL: Changelog, https://github.com/shenmishajing/speed_benchmark/blob/main/docs/get_started/changelog.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: GPU :: NVIDIA CUDA
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Natural Language :: English
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: matplotlib
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: commitizen; extra == "dev"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx-autobuild; extra == "doc"
Requires-Dist: sphinx-book-theme; extra == "doc"
Requires-Dist: sphinx-autoapi; extra == "doc"
Requires-Dist: myst-parser; extra == "doc"
Requires-Dist: sphinx_design; extra == "doc"
Provides-Extra: build
Requires-Dist: build; extra == "build"
Provides-Extra: test
Requires-Dist: tox; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: all
Requires-Dist: speed-benchmark[build,dev,doc,test]; extra == "all"

# Speed Benchmark

A generic speed benchmark library. It runs every function with every arg to get the average time cost and also checks the result.

## Installation

```bash
pip install speed-benchmark
```

## Contribution

See [contribution docs](docs/get_started/contribution.md) for details.

## Release versions

We use [setuptools_scm](https://github.com/pypa/setuptools_scm/) for versioning. For the versions available, see the [tags](https://github.com/shenmishajing/speed_benchmark/tags) on this repository.

## License

This project is licensed under the MIT License.

## Star History

<picture>
  <source
    media="(prefers-color-scheme: dark)"
    srcset="
      https://api.star-history.com/svg?repos=shenmishajing/speed_benchmark&type=Date&theme=dark
    "
  />
  <source
    media="(prefers-color-scheme: light)"
    srcset="
      https://api.star-history.com/svg?repos=shenmishajing/speed_benchmark&type=Date
    "
  />
  <img
    alt="Star History Chart"
    src="https://api.star-history.com/svg?repos=shenmishajing/speed_benchmark&type=Date"
  />
</picture>
