# arkas
<p align="center">
<a href="https://github.com/durandtibo/arkas/actions">
<img alt="CI" src="https://github.com/durandtibo/arkas/workflows/CI/badge.svg">
</a>
<a href="https://github.com/durandtibo/arkas/actions">
<img alt="Nightly Tests" src="https://github.com/durandtibo/arkas/workflows/Nightly%20Tests/badge.svg">
</a>
<a href="https://github.com/durandtibo/arkas/actions">
<img alt="Nightly Package Tests" src="https://github.com/durandtibo/arkas/workflows/Nightly%20Package%20Tests/badge.svg">
</a>
<br/>
<a href="https://durandtibo.github.io/arkas/">
<img alt="Documentation" src="https://github.com/durandtibo/arkas/workflows/Documentation%20(stable)/badge.svg">
</a>
<a href="https://durandtibo.github.io/arkas/dev/">
<img alt="Documentation" src="https://github.com/durandtibo/arkas/workflows/Documentation%20(unstable)/badge.svg">
</a>
<br/>
<a href="https://codecov.io/gh/durandtibo/arkas">
<img alt="Codecov" src="https://codecov.io/gh/durandtibo/arkas/branch/main/graph/badge.svg">
</a>
<a href="https://codeclimate.com/github/durandtibo/arkas/maintainability">
<img src="https://api.codeclimate.com/v1/badges/bc15147bbdd318137184/maintainability" />
</a>
<a href="https://codeclimate.com/github/durandtibo/arkas/test_coverage">
<img src="https://api.codeclimate.com/v1/badges/bc15147bbdd318137184/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/arkas/">
<img alt="PYPI version" src="https://img.shields.io/pypi/v/arkas">
</a>
<a href="https://pypi.org/project/arkas/">
<img alt="Python" src="https://img.shields.io/pypi/pyversions/arkas.svg">
</a>
<a href="https://opensource.org/licenses/BSD-3-Clause">
<img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/arkas">
</a>
<br/>
<a href="https://pepy.tech/project/arkas">
<img alt="Downloads" src="https://static.pepy.tech/badge/arkas">
</a>
<a href="https://pepy.tech/project/arkas">
<img alt="Monthly downloads" src="https://static.pepy.tech/badge/arkas/month">
</a>
<br/>
</p>
## Overview
`arkas` is a simple Python library to evaluate ML model performances.
## Installation
We highly recommend installing
a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
`arkas` can be installed from pip using the following command:
```shell
pip install arkas
```
To make the package as slim as possible, only the minimal packages required to use `arkas` are
installed.
To include all the dependencies, you can use the following command:
```shell
pip install arkas[all]
```
Please check the [get started page](https://durandtibo.github.io/arkas/get_started) to see how to
install only some specific dependencies or other alternatives to install the library.
The following is the corresponding `arkas` versions and tested dependencies.
| `arkas` | `coola` | `grizz` | `iden` | `matplotlib` | `numpy` | `objectory` | `polars` | `scikit-learn` | `python` |
|---------|----------------|----------------|----------------|--------------|---------------|--------------|--------------|----------------|---------------|
| `main` | `>=0.8.2,<1.0` | `>=0.0.5,<1.0` | `>=0.0.4,<1.0` | `>=3.6,<4.0` | `>=1.22,<2.0` | `>=0.1,<1.0` | `>=1.0,<2.0` | `>=1.3,<2.0` | `>=3.9,<3.12` |
| `arkas` | `colorlog`<sup>*</sup> | `hya`<sup>*</sup> | `markdown`<sup>*</sup> | `tqdm`<sup>*</sup> |
|---------|------------------------|-------------------|------------------------|--------------------|
| `main` | `>=6.7,<7.0` | `>=0.2,<1.0` | `>=3.4,<4.0` | `>=4.65,<5.0` |
<sup>*</sup> indicates an optional dependency
## 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/arkas/issues).
We will reply to you as soon as possible. Thank you very much.
## API stability
:warning: While `arkas` 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 `arkas` to a new version will possibly break any code that
was using the old version of `arkas`.
## License
`arkas` 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/arkas",
"name": "arkas",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Thibaut Durand",
"author_email": "durand.tibo+gh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/18/37/9abfb765985937708e9985bbac7be9fc404daed8debd357621b8a79bd754/arkas-0.0.1a0.tar.gz",
"platform": null,
"description": "# arkas\n\n<p align=\"center\">\n <a href=\"https://github.com/durandtibo/arkas/actions\">\n <img alt=\"CI\" src=\"https://github.com/durandtibo/arkas/workflows/CI/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/arkas/actions\">\n <img alt=\"Nightly Tests\" src=\"https://github.com/durandtibo/arkas/workflows/Nightly%20Tests/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/arkas/actions\">\n <img alt=\"Nightly Package Tests\" src=\"https://github.com/durandtibo/arkas/workflows/Nightly%20Package%20Tests/badge.svg\">\n </a>\n <br/>\n <a href=\"https://durandtibo.github.io/arkas/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/arkas/workflows/Documentation%20(stable)/badge.svg\">\n </a>\n <a href=\"https://durandtibo.github.io/arkas/dev/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/arkas/workflows/Documentation%20(unstable)/badge.svg\">\n </a>\n <br/>\n <a href=\"https://codecov.io/gh/durandtibo/arkas\">\n <img alt=\"Codecov\" src=\"https://codecov.io/gh/durandtibo/arkas/branch/main/graph/badge.svg\">\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/arkas/maintainability\">\n <img src=\"https://api.codeclimate.com/v1/badges/bc15147bbdd318137184/maintainability\" />\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/arkas/test_coverage\">\n <img src=\"https://api.codeclimate.com/v1/badges/bc15147bbdd318137184/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/arkas/\">\n <img alt=\"PYPI version\" src=\"https://img.shields.io/pypi/v/arkas\">\n </a>\n <a href=\"https://pypi.org/project/arkas/\">\n <img alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/arkas.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/arkas\">\n </a>\n <br/>\n <a href=\"https://pepy.tech/project/arkas\">\n <img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/arkas\">\n </a>\n <a href=\"https://pepy.tech/project/arkas\">\n <img alt=\"Monthly downloads\" src=\"https://static.pepy.tech/badge/arkas/month\">\n </a>\n <br/>\n</p>\n\n## Overview\n\n`arkas` is a simple Python library to evaluate ML model performances.\n\n## Installation\n\nWe highly recommend installing\na [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).\n`arkas` can be installed from pip using the following command:\n\n```shell\npip install arkas\n```\n\nTo make the package as slim as possible, only the minimal packages required to use `arkas` are\ninstalled.\nTo include all the dependencies, you can use the following command:\n\n```shell\npip install arkas[all]\n```\n\nPlease check the [get started page](https://durandtibo.github.io/arkas/get_started) to see how to\ninstall only some specific dependencies or other alternatives to install the library.\nThe following is the corresponding `arkas` versions and tested dependencies.\n\n| `arkas` | `coola` | `grizz` | `iden` | `matplotlib` | `numpy` | `objectory` | `polars` | `scikit-learn` | `python` |\n|---------|----------------|----------------|----------------|--------------|---------------|--------------|--------------|----------------|---------------|\n| `main` | `>=0.8.2,<1.0` | `>=0.0.5,<1.0` | `>=0.0.4,<1.0` | `>=3.6,<4.0` | `>=1.22,<2.0` | `>=0.1,<1.0` | `>=1.0,<2.0` | `>=1.3,<2.0` | `>=3.9,<3.12` |\n\n| `arkas` | `colorlog`<sup>*</sup> | `hya`<sup>*</sup> | `markdown`<sup>*</sup> | `tqdm`<sup>*</sup> |\n|---------|------------------------|-------------------|------------------------|--------------------|\n| `main` | `>=6.7,<7.0` | `>=0.2,<1.0` | `>=3.4,<4.0` | `>=4.65,<5.0` |\n\n<sup>*</sup> indicates an optional dependency\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/arkas/issues).\nWe will reply to you as soon as possible. Thank you very much.\n\n## API stability\n\n:warning: While `arkas` 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 `arkas` to a new version will possibly break any code that\nwas using the old version of `arkas`.\n\n## License\n\n`arkas` is licensed under BSD 3-Clause \"New\" or \"Revised\" license available in [LICENSE](LICENSE)\nfile.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Library to evaluate ML model performances",
"version": "0.0.1a0",
"project_urls": {
"Homepage": "https://github.com/durandtibo/arkas",
"Repository": "https://github.com/durandtibo/arkas"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9c14674ee03f3101968b080b5e89685b1f583b02af60a7ad16def47e9ecaf29c",
"md5": "aa3599ba8cab5bf4c3143e4bf6b715e4",
"sha256": "60e627368f18b6ba4986d0def74a9d1d38e15f38eeef50268bfd6e7276915bf5"
},
"downloads": -1,
"filename": "arkas-0.0.1a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa3599ba8cab5bf4c3143e4bf6b715e4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 99496,
"upload_time": "2024-09-06T06:30:30",
"upload_time_iso_8601": "2024-09-06T06:30:30.740217Z",
"url": "https://files.pythonhosted.org/packages/9c/14/674ee03f3101968b080b5e89685b1f583b02af60a7ad16def47e9ecaf29c/arkas-0.0.1a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "18379abfb765985937708e9985bbac7be9fc404daed8debd357621b8a79bd754",
"md5": "3eff4c02ce193e9401501ed6fadec223",
"sha256": "8895c54ee8ed8169955c5fd9a1f47f1a9e7eb2d8188e8b6de6736e65a6acce9b"
},
"downloads": -1,
"filename": "arkas-0.0.1a0.tar.gz",
"has_sig": false,
"md5_digest": "3eff4c02ce193e9401501ed6fadec223",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 44350,
"upload_time": "2024-09-06T06:30:32",
"upload_time_iso_8601": "2024-09-06T06:30:32.481804Z",
"url": "https://files.pythonhosted.org/packages/18/37/9abfb765985937708e9985bbac7be9fc404daed8debd357621b8a79bd754/arkas-0.0.1a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-06 06:30:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "durandtibo",
"github_project": "arkas",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "arkas"
}
JSON
