karbonn 0.0.4a0
A library of PyTorch modules
License: BSD-3-Clause
Requires Python: <3.13,>=3.9

# 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`        | `minrecord`    | `numpy`<sup>*</sup> | `objectory`<sup>*</sup> | `pytorch-ignite`<sup>*</sup> | `tabulate`<sup>*</sup> | `torch`       | `python`      |
|-----------|----------------|----------------|---------------------|-------------------------|------------------------------|------------------------|---------------|---------------|
| `main`    | `>=0.8.2,<1.0` | `>=0.0.2,<1.0` | `>=1.22,<3.0`       | `>=0.1,<1.0`            | `>=0.4.11,<1.0`              | `>=0.9,<0.10`          | `>=1.12,<3.0` | `>=3.9,<3.13` |
| `0.0.3`   | `>=0.8.2,<1.0` | `>=0.0.2,<1.0` | `>=1.22,<3.0`       | `>=0.1,<1.0`            | `>=0.4.11,<1.0`              | `>=0.9,<0.10`          | `>=1.12,<3.0` | `>=3.9,<3.13` |
| `0.0.2`   | `>=0.8.2,<1.0` | `>=0.0.2,<1.0` | `>=1.22,<3.0`       | `>=0.1,<1.0`            | `>=0.4.11,<1.0`              | `>=0.9,<0.10`          | `>=1.12,<3.0` | `>=3.9,<3.13` |
| `0.0.1`   | `>=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.