# minrecord
<p align="center">
<a href="https://github.com/durandtibo/minrecord/actions">
<img alt="CI" src="https://github.com/durandtibo/minrecord/workflows/CI/badge.svg">
</a>
<a href="https://github.com/durandtibo/minrecord/actions">
<img alt="Nightly Tests" src="https://github.com/durandtibo/minrecord/workflows/Nightly%20Tests/badge.svg">
</a>
<a href="https://github.com/durandtibo/minrecord/actions">
<img alt="Nightly Package Tests" src="https://github.com/durandtibo/minrecord/workflows/Nightly%20Package%20Tests/badge.svg">
</a>
<br/>
<a href="https://durandtibo.github.io/minrecord/">
<img alt="Documentation" src="https://github.com/durandtibo/minrecord/workflows/Documentation%20(stable)/badge.svg">
</a>
<a href="https://durandtibo.github.io/minrecord/">
<img alt="Documentation" src="https://github.com/durandtibo/minrecord/workflows/Documentation%20(unstable)/badge.svg">
</a>
<br/>
<a href="https://codecov.io/gh/durandtibo/minrecord">
<img alt="Codecov" src="https://codecov.io/gh/durandtibo/minrecord/branch/main/graph/badge.svg">
</a>
<a href="https://codeclimate.com/github/durandtibo/minrecord/maintainability">
<img src="https://api.codeclimate.com/v1/badges/d6e3047eedfd2e1e0d86/maintainability" />
</a>
<a href="https://codeclimate.com/github/durandtibo/minrecord/test_coverage">
<img src="https://api.codeclimate.com/v1/badges/d6e3047eedfd2e1e0d86/test_coverage" />
</a>
<br/>
<a href="https://github.com/psf/black">
<img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
</a>
<a href="https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings">
<img alt="Doc style: google" src="https://img.shields.io/badge/%20style-google-3666d6.svg">
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;">
</a>
<a href="https://github.com/guilatrova/tryceratops">
<img alt="Doc style: google" src="https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black">
</a>
<br/>
<a href="https://pypi.org/project/minrecord/">
<img alt="PYPI version" src="https://img.shields.io/pypi/v/minrecord">
</a>
<a href="https://pypi.org/project/minrecord/">
<img alt="Python" src="https://img.shields.io/pypi/pyversions/minrecord.svg">
</a>
<a href="https://opensource.org/licenses/BSD-3-Clause">
<img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/minrecord">
</a>
<br/>
<a href="https://pepy.tech/project/minrecord">
<img alt="Downloads" src="https://static.pepy.tech/badge/minrecord">
</a>
<a href="https://pepy.tech/project/minrecord">
<img alt="Monthly downloads" src="https://static.pepy.tech/badge/minrecord/month">
</a>
<br/>
</p>
## Overview
`minrecord` is a minimalist Python library to record values in a ML workflow.
In particular, it provides functionalities to track the best value, or the most recent values by
storing a limiting number of values.
It is possible to customize the library e.g. it is possible to define a new logic to track the best
value.
Below is an example to show how to track the best scalar value when the best value is the maximum
value and when the best value is the minimum value.
```pycon
>>> from minrecord import MaxScalarRecord, MinScalarRecord
>>> record_max = MaxScalarRecord("accuracy")
>>> record_max.update([(0, 42), (None, 45), (2, 46)])
>>> record_max.add_value(40)
>>> record_max.get_best_value()
46
>>> record_min = MinScalarRecord("loss")
>>> record_min.update([(0, 42), (None, 45), (2, 46)])
>>> record_min.add_value(50)
>>> record_min.get_best_value()
42
```
## Documentation
- [latest (stable)](https://durandtibo.github.io/minrecord/): documentation from the latest stable
release.
- [main (unstable)](https://durandtibo.github.io/minrecord/main/): documentation associated to the
main branch of the repo. This documentation may contain a lot of work-in-progress/outdated/missing
parts.
## Installation
We highly recommend installing
a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
`minrecord` can be installed from pip using the following command:
```shell
pip install minrecord
```
To make the package as slim as possible, only the minimal packages required to use `minrecord` are
installed.
To include all the dependencies, you can use the following command:
```shell
pip install minrecord[all]
```
Please check the [get started page](https://durandtibo.github.io/minrecord/get_started) to see how
to
install only some specific dependencies or other alternatives to install the library.
The following is the corresponding `minrecord` versions and tested dependencies.
| `minrecord` | `coola` | `objectory` | `python` |
|-------------|--------------|--------------|---------------|
| `main` | `>=0.7,<1.0` | `>=0.1,<1.0` | `>=3.9,<3.13` |
| `0.0.1` | `>=0.7,<1.0` | `>=0.1,<1.0` | `>=3.9,<3.13` |
## Contributing
Please check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).
## Suggestions and Communication
Everyone is welcome to contribute to the community.
If you have any questions or suggestions, you can
submit [Github Issues](https://github.com/durandtibo/minrecord/issues).
We will reply to you as soon as possible. Thank you very much.
## API stability
:warning: While `minrecord` is in development stage, no API is guaranteed to be stable from one
release to the next.
In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release.
In practice, this means that upgrading `minrecord` to a new version will possibly break any code
that
was using the old version of `minrecord`.
## License
`minrecord` is licensed under BSD 3-Clause "New" or "Revised" license available
in [LICENSE](LICENSE)
file.
Raw data
{
"_id": null,
"home_page": "https://github.com/durandtibo/minrecord",
"name": "minrecord",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "record, machine learning",
"author": "Thibaut Durand",
"author_email": "durand.tibo+gh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c5/a2/c909ed0b0b09bf54b68b692990d0ab8b6e42963b542ddd6ec6009fda38a0/minrecord-0.0.1.tar.gz",
"platform": null,
"description": "# minrecord\n\n<p align=\"center\">\n <a href=\"https://github.com/durandtibo/minrecord/actions\">\n <img alt=\"CI\" src=\"https://github.com/durandtibo/minrecord/workflows/CI/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/minrecord/actions\">\n <img alt=\"Nightly Tests\" src=\"https://github.com/durandtibo/minrecord/workflows/Nightly%20Tests/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/minrecord/actions\">\n <img alt=\"Nightly Package Tests\" src=\"https://github.com/durandtibo/minrecord/workflows/Nightly%20Package%20Tests/badge.svg\">\n </a>\n <br/>\n <a href=\"https://durandtibo.github.io/minrecord/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/minrecord/workflows/Documentation%20(stable)/badge.svg\">\n </a>\n <a href=\"https://durandtibo.github.io/minrecord/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/minrecord/workflows/Documentation%20(unstable)/badge.svg\">\n </a>\n <br/>\n <a href=\"https://codecov.io/gh/durandtibo/minrecord\">\n <img alt=\"Codecov\" src=\"https://codecov.io/gh/durandtibo/minrecord/branch/main/graph/badge.svg\">\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/minrecord/maintainability\">\n <img src=\"https://api.codeclimate.com/v1/badges/d6e3047eedfd2e1e0d86/maintainability\" />\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/minrecord/test_coverage\">\n <img src=\"https://api.codeclimate.com/v1/badges/d6e3047eedfd2e1e0d86/test_coverage\" />\n </a>\n <br/>\n <a href=\"https://github.com/psf/black\">\n <img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\">\n </a>\n <a href=\"https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings\">\n <img alt=\"Doc style: google\" src=\"https://img.shields.io/badge/%20style-google-3666d6.svg\">\n </a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\" alt=\"Ruff\" style=\"max-width:100%;\">\n </a>\n <a href=\"https://github.com/guilatrova/tryceratops\">\n <img alt=\"Doc style: google\" src=\"https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black\">\n </a>\n <br/>\n <a href=\"https://pypi.org/project/minrecord/\">\n <img alt=\"PYPI version\" src=\"https://img.shields.io/pypi/v/minrecord\">\n </a>\n <a href=\"https://pypi.org/project/minrecord/\">\n <img alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/minrecord.svg\">\n </a>\n <a href=\"https://opensource.org/licenses/BSD-3-Clause\">\n <img alt=\"BSD-3-Clause\" src=\"https://img.shields.io/pypi/l/minrecord\">\n </a>\n <br/>\n <a href=\"https://pepy.tech/project/minrecord\">\n <img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/minrecord\">\n </a>\n <a href=\"https://pepy.tech/project/minrecord\">\n <img alt=\"Monthly downloads\" src=\"https://static.pepy.tech/badge/minrecord/month\">\n </a>\n <br/>\n</p>\n\n## Overview\n\n`minrecord` is a minimalist Python library to record values in a ML workflow.\nIn particular, it provides functionalities to track the best value, or the most recent values by\nstoring a limiting number of values.\nIt is possible to customize the library e.g. it is possible to define a new logic to track the best\nvalue.\nBelow is an example to show how to track the best scalar value when the best value is the maximum\nvalue and when the best value is the minimum value.\n\n```pycon\n\n>>> from minrecord import MaxScalarRecord, MinScalarRecord\n>>> record_max = MaxScalarRecord(\"accuracy\")\n>>> record_max.update([(0, 42), (None, 45), (2, 46)])\n>>> record_max.add_value(40)\n>>> record_max.get_best_value()\n46\n>>> record_min = MinScalarRecord(\"loss\")\n>>> record_min.update([(0, 42), (None, 45), (2, 46)])\n>>> record_min.add_value(50)\n>>> record_min.get_best_value()\n42\n\n```\n\n## Documentation\n\n- [latest (stable)](https://durandtibo.github.io/minrecord/): documentation from the latest stable\n release.\n- [main (unstable)](https://durandtibo.github.io/minrecord/main/): documentation associated to the\n main branch of the repo. This documentation may contain a lot of work-in-progress/outdated/missing\n parts.\n\n## Installation\n\nWe highly recommend installing\na [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).\n`minrecord` can be installed from pip using the following command:\n\n```shell\npip install minrecord\n```\n\nTo make the package as slim as possible, only the minimal packages required to use `minrecord` are\ninstalled.\nTo include all the dependencies, you can use the following command:\n\n```shell\npip install minrecord[all]\n```\n\nPlease check the [get started page](https://durandtibo.github.io/minrecord/get_started) to see how\nto\ninstall only some specific dependencies or other alternatives to install the library.\nThe following is the corresponding `minrecord` versions and tested dependencies.\n\n| `minrecord` | `coola` | `objectory` | `python` |\n|-------------|--------------|--------------|---------------|\n| `main` | `>=0.7,<1.0` | `>=0.1,<1.0` | `>=3.9,<3.13` |\n| `0.0.1` | `>=0.7,<1.0` | `>=0.1,<1.0` | `>=3.9,<3.13` |\n\n## Contributing\n\nPlease check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).\n\n## Suggestions and Communication\n\nEveryone is welcome to contribute to the community.\nIf you have any questions or suggestions, you can\nsubmit [Github Issues](https://github.com/durandtibo/minrecord/issues).\nWe will reply to you as soon as possible. Thank you very much.\n\n## API stability\n\n:warning: While `minrecord` is in development stage, no API is guaranteed to be stable from one\nrelease to the next.\nIn fact, it is very likely that the API will change multiple times before a stable 1.0.0 release.\nIn practice, this means that upgrading `minrecord` to a new version will possibly break any code\nthat\nwas using the old version of `minrecord`.\n\n## License\n\n`minrecord` is licensed under BSD 3-Clause \"New\" or \"Revised\" license available\nin [LICENSE](LICENSE)\nfile.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Minimalist library to record values in a ML workflow",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/durandtibo/minrecord",
"Repository": "https://github.com/durandtibo/minrecord"
},
"split_keywords": [
"record",
" machine learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87155fa9a7b2e8cda48b1555cbd78a34700869e2d36cf5c4bb6bab8087b7da21",
"md5": "933fde7c9d8bea4451ba734240827f4c",
"sha256": "52585238b3708dedd799e63621e07937c903e7c8e43e4827db0752c603991906"
},
"downloads": -1,
"filename": "minrecord-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "933fde7c9d8bea4451ba734240827f4c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 17048,
"upload_time": "2024-06-12T05:39:19",
"upload_time_iso_8601": "2024-06-12T05:39:19.094504Z",
"url": "https://files.pythonhosted.org/packages/87/15/5fa9a7b2e8cda48b1555cbd78a34700869e2d36cf5c4bb6bab8087b7da21/minrecord-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c5a2c909ed0b0b09bf54b68b692990d0ab8b6e42963b542ddd6ec6009fda38a0",
"md5": "777a6af2dca4724993851f773e0a2dd0",
"sha256": "9135aa705016bc0ba5be024f9c090efcb236af1ecdadff7c3566e5d3eb5a5e53"
},
"downloads": -1,
"filename": "minrecord-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "777a6af2dca4724993851f773e0a2dd0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 15968,
"upload_time": "2024-06-12T05:39:20",
"upload_time_iso_8601": "2024-06-12T05:39:20.446094Z",
"url": "https://files.pythonhosted.org/packages/c5/a2/c909ed0b0b09bf54b68b692990d0ab8b6e42963b542ddd6ec6009fda38a0/minrecord-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-12 05:39:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "durandtibo",
"github_project": "minrecord",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "minrecord"
}
JSON
