Benchmate API documentation

This is the comprehensive API documentation that include all the functions classes and methods that are in the package. A lot of these methods are for internal use only but are included here for reference and for those who want to contribute to benchmate.

There might be changes in the code that may or may not be reflected in the documentation. If there are consistencies the code should be regarded as the truth. We try to provide instructive docstrings for every function, method and class unless it is very obvious (like an __eq__ method, or a self explanatory dataclass or custom exception).

Feel free to update and edit this documentation and create a pull request.


Table of contents


This site uses Just the Docs, a documentation theme for Jekyll.