# karbonn
<p align="center">
<a href="https://github.com/durandtibo/karbonn/actions">
<img alt="CI" src="https://github.com/durandtibo/karbonn/workflows/CI/badge.svg">
</a>
<a href="https://github.com/durandtibo/karbonn/actions">
<img alt="Nightly Tests" src="https://github.com/durandtibo/karbonn/workflows/Nightly%20Tests/badge.svg">
</a>
<a href="https://github.com/durandtibo/karbonn/actions">
<img alt="Nightly Package Tests" src="https://github.com/durandtibo/karbonn/workflows/Nightly%20Package%20Tests/badge.svg">
</a>
<br/>
<a href="https://durandtibo.github.io/karbonn/">
<img alt="Documentation" src="https://github.com/durandtibo/karbonn/workflows/Documentation%20(stable)/badge.svg">
</a>
<a href="https://durandtibo.github.io/karbonn/">
<img alt="Documentation" src="https://github.com/durandtibo/karbonn/workflows/Documentation%20(unstable)/badge.svg">
</a>
<br/>
<a href="https://codecov.io/gh/durandtibo/karbonn">
<img alt="Codecov" src="https://codecov.io/gh/durandtibo/karbonn/branch/main/graph/badge.svg">
</a>
<a href="https://codeclimate.com/github/durandtibo/karbonn/maintainability">
<img src="https://api.codeclimate.com/v1/badges/1d66f4218d5da81c2ed0/maintainability" />
</a>
<a href="https://codeclimate.com/github/durandtibo/karbonn/test_coverage">
<img src="https://api.codeclimate.com/v1/badges/1d66f4218d5da81c2ed0/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/karbonn/">
<img alt="PYPI version" src="https://img.shields.io/pypi/v/karbonn">
</a>
<a href="https://pypi.org/project/karbonn/">
<img alt="Python" src="https://img.shields.io/pypi/pyversions/karbonn.svg">
</a>
<a href="https://opensource.org/licenses/BSD-3-Clause">
<img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/karbonn">
</a>
<br/>
<a href="https://pepy.tech/project/karbonn">
<img alt="Downloads" src="https://static.pepy.tech/badge/karbonn">
</a>
<a href="https://pepy.tech/project/karbonn">
<img alt="Monthly downloads" src="https://static.pepy.tech/badge/karbonn/month">
</a>
<br/>
</p>
A library of PyTorch modules
## Installation
We highly recommend installing
a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
`karbonn` can be installed from pip using the following command:
```shell
pip install karbonn
```
To make the package as slim as possible, only the minimal packages required to use `karbonn` are
installed.
To include all the dependencies, you can use the following command:
```shell
pip install karbonn[all]
```
Please check the [get started page](https://durandtibo.github.io/karbonn/get_started) to see how to
install only some specific dependencies or other alternatives to install the library.
The following is the corresponding `karbonn` versions and tested dependencies.
| `karbonn` | `coola` | `numpy`<sup>*</sup> | `objectory`<sup>*</sup> | `tabulate`<sup>*</sup> | `torch` | `python` |
|-----------|--------------|---------------------|-------------------------|------------------------|---------------|---------------|
| `main` | `>=0.5,<1.0` | `>=1.22,<2.0` | `>=0.1,<1.0` | `>=0.9,<0.10` | `>=1.10,<3.0` | `>=3.9,<3.13` |
<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/karbonn/issues).
We will reply to you as soon as possible. Thank you very much.
## API stability
:warning: While `karbonn` 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 `karbonn` to a new version will possibly break any code that
was using the old version of `karbonn`.
## License
`karbonn` 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/karbonn",
"name": "karbonn",
"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/b1/00/c127e19c70109afa4644f36b966520c4f27da667983cb027bcab99d50b35/karbonn-0.0.1a2.tar.gz",
"platform": null,
"description": "# karbonn\n\n<p align=\"center\">\n <a href=\"https://github.com/durandtibo/karbonn/actions\">\n <img alt=\"CI\" src=\"https://github.com/durandtibo/karbonn/workflows/CI/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/karbonn/actions\">\n <img alt=\"Nightly Tests\" src=\"https://github.com/durandtibo/karbonn/workflows/Nightly%20Tests/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/karbonn/actions\">\n <img alt=\"Nightly Package Tests\" src=\"https://github.com/durandtibo/karbonn/workflows/Nightly%20Package%20Tests/badge.svg\">\n </a>\n <br/>\n <a href=\"https://durandtibo.github.io/karbonn/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/karbonn/workflows/Documentation%20(stable)/badge.svg\">\n </a>\n <a href=\"https://durandtibo.github.io/karbonn/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/karbonn/workflows/Documentation%20(unstable)/badge.svg\">\n </a>\n <br/>\n <a href=\"https://codecov.io/gh/durandtibo/karbonn\">\n <img alt=\"Codecov\" src=\"https://codecov.io/gh/durandtibo/karbonn/branch/main/graph/badge.svg\">\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/karbonn/maintainability\">\n <img src=\"https://api.codeclimate.com/v1/badges/1d66f4218d5da81c2ed0/maintainability\" />\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/karbonn/test_coverage\">\n <img src=\"https://api.codeclimate.com/v1/badges/1d66f4218d5da81c2ed0/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/karbonn/\">\n <img alt=\"PYPI version\" src=\"https://img.shields.io/pypi/v/karbonn\">\n </a>\n <a href=\"https://pypi.org/project/karbonn/\">\n <img alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/karbonn.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/karbonn\">\n </a>\n <br/>\n <a href=\"https://pepy.tech/project/karbonn\">\n <img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/karbonn\">\n </a>\n <a href=\"https://pepy.tech/project/karbonn\">\n <img alt=\"Monthly downloads\" src=\"https://static.pepy.tech/badge/karbonn/month\">\n </a>\n <br/>\n</p>\n\nA library of PyTorch modules\n\n## Installation\n\nWe highly recommend installing\na [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).\n`karbonn` can be installed from pip using the following command:\n\n```shell\npip install karbonn\n```\n\nTo make the package as slim as possible, only the minimal packages required to use `karbonn` are\ninstalled.\nTo include all the dependencies, you can use the following command:\n\n```shell\npip install karbonn[all]\n```\n\nPlease check the [get started page](https://durandtibo.github.io/karbonn/get_started) to see how to\ninstall only some specific dependencies or other alternatives to install the library.\nThe following is the corresponding `karbonn` versions and tested dependencies.\n\n| `karbonn` | `coola` | `numpy`<sup>*</sup> | `objectory`<sup>*</sup> | `tabulate`<sup>*</sup> | `torch` | `python` |\n|-----------|--------------|---------------------|-------------------------|------------------------|---------------|---------------|\n| `main` | `>=0.5,<1.0` | `>=1.22,<2.0` | `>=0.1,<1.0` | `>=0.9,<0.10` | `>=1.10,<3.0` | `>=3.9,<3.13` |\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/karbonn/issues).\nWe will reply to you as soon as possible. Thank you very much.\n\n## API stability\n\n:warning: While `karbonn` 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 `karbonn` to a new version will possibly break any code that\nwas using the old version of `karbonn`.\n\n## License\n\n`karbonn` is licensed under BSD 3-Clause \"New\" or \"Revised\" license available in [LICENSE](LICENSE)\nfile.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A library of PyTorch modules",
"version": "0.0.1a2",
"project_urls": {
"Homepage": "https://github.com/durandtibo/karbonn",
"Repository": "https://github.com/durandtibo/karbonn"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a1c22cdd4c039ab97e19299858af465fa7fe159d914a8bcca482a046097a80d",
"md5": "197eae2a794889f87adbc6cead7a1d45",
"sha256": "f34b4175d37d6e731c768ddcb437f486a84ef95667200151bb536d04423f415b"
},
"downloads": -1,
"filename": "karbonn-0.0.1a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "197eae2a794889f87adbc6cead7a1d45",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 69249,
"upload_time": "2024-04-09T07:11:20",
"upload_time_iso_8601": "2024-04-09T07:11:20.073639Z",
"url": "https://files.pythonhosted.org/packages/2a/1c/22cdd4c039ab97e19299858af465fa7fe159d914a8bcca482a046097a80d/karbonn-0.0.1a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b100c127e19c70109afa4644f36b966520c4f27da667983cb027bcab99d50b35",
"md5": "5852b9a86f3cace93fe830a5929bc384",
"sha256": "e3adb4117c981e59e85c2408d9336e16bf27a02cbede9917c5379c7cef2a501f"
},
"downloads": -1,
"filename": "karbonn-0.0.1a2.tar.gz",
"has_sig": false,
"md5_digest": "5852b9a86f3cace93fe830a5929bc384",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 41852,
"upload_time": "2024-04-09T07:11:21",
"upload_time_iso_8601": "2024-04-09T07:11:21.213382Z",
"url": "https://files.pythonhosted.org/packages/b1/00/c127e19c70109afa4644f36b966520c4f27da667983cb027bcab99d50b35/karbonn-0.0.1a2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 07:11:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "durandtibo",
"github_project": "karbonn",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "karbonn"
}
JSON
