https://github.com/durandtibo/karbonn
A library of PyTorch modules
https://github.com/durandtibo/karbonn
Last synced: about 2 months ago
JSON representation
A library of PyTorch modules
- Host: GitHub
- URL: https://github.com/durandtibo/karbonn
- Owner: durandtibo
- License: bsd-3-clause
- Created: 2024-03-17T23:41:24.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:06:03.000Z (7 months ago)
- Last Synced: 2024-10-29T09:23:40.805Z (7 months ago)
- Language: Python
- Homepage: https://durandtibo.github.io/karbonn/
- Size: 3.54 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# karbonn
/badge.svg)
/badge.svg)
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`* | `objectory`* | `pytorch-ignite`* | `tabulate`* | `torch` | `python` |
|-----------|----------------|----------------|---------------------|-------------------------|------------------------------|------------------------|---------------|---------------|
| `main` | `>=0.8.6,<1.0` | `>=0.1,<1.0` | `>=1.22,<3.0` | `>=0.2,<1.0` | `>=0.4.11,<1.0` | `>=0.9,<0.10` | `>=2.0,<3.0` | `>=3.9,<3.14` |
| `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` |
* 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.