# redcat
<p align="center">
<a href="https://github.com/durandtibo/redcat/actions">
<img alt="CI" src="https://github.com/durandtibo/redcat/workflows/CI/badge.svg">
</a>
<a href="https://durandtibo.github.io/redcat/">
<img alt="Documentation" src="https://github.com/durandtibo/redcat/workflows/Documentation/badge.svg">
</a>
<a href="https://github.com/durandtibo/redcat/actions">
<img alt="Nightly Tests" src="https://github.com/durandtibo/redcat/workflows/Nightly%20Tests/badge.svg">
</a>
<a href="https://github.com/durandtibo/redcat/actions">
<img alt="Nightly Package Tests" src="https://github.com/durandtibo/redcat/workflows/Nightly%20Package%20Tests/badge.svg">
</a>
<br/>
<a href="https://codecov.io/gh/durandtibo/redcat">
<img alt="Codecov" src="https://codecov.io/gh/durandtibo/redcat/branch/main/graph/badge.svg">
</a>
<a href="https://codeclimate.com/github/durandtibo/redcat/maintainability">
<img src="https://api.codeclimate.com/v1/badges/0987ab26fe4d52025085/maintainability" />
</a>
<a href="https://codeclimate.com/github/durandtibo/redcat/test_coverage">
<img src="https://api.codeclimate.com/v1/badges/0987ab26fe4d52025085/test_coverage" />
</a>
<br/>
<a href="https://pypi.org/project/redcat/">
<img alt="PYPI version" src="https://img.shields.io/pypi/v/redcat">
</a>
<a href="https://pypi.org/project/redcat/">
<img alt="Python" src="https://img.shields.io/pypi/pyversions/redcat.svg">
</a>
<a href="https://opensource.org/licenses/BSD-3-Clause">
<img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/redcat">
</a>
<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>
<br/>
<a href="https://pepy.tech/project/redcat">
<img alt="Downloads" src="https://static.pepy.tech/badge/redcat">
</a>
<a href="https://pepy.tech/project/redcat">
<img alt="Monthly downloads" src="https://static.pepy.tech/badge/redcat/month">
</a>
<br/>
</p>
<p align="center">
<img height="242" src="assets/redcat.png" alt="logo"/>
</p>
---
## Philosophy
- `BatchedTensor` and `BatchedTensorSeq` must behave like `torch.Tensor`
- `BatchedArray` and `BatchedArraySeq` must behave like `numpy.ndarray`
- `BatchedTensor` (resp. `BatchedTensorSeq`) does not have to behave like `BatchedArray` (
resp. `BatchedArraySeq`)
## Installation
We highly recommend installing
a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
`redcat` can be installed from pip using the following command:
```shell
pip install redcat
```
To make the package as slim as possible, only the minimal packages required to use `redcat` are
installed.
To include all the dependencies, you can use the following command:
```shell
pip install redcat[all]
```
Please check the [get started page](https://durandtibo.github.io/redcat/get_started) to see how to
install only some specific dependencies or other alternatives to install the library.
The following is the corresponding `redcat` versions and supported Python, PyTorch and NumPy
versions.
| `redcat` | `coola` | `numpy` | `torch` | `python` |
|----------|--------------------|----------------|---------------|---------------|
| `main` | `>=0.0.20,<0.2` | `>=1.22,<2.0` | `>=1.11,<3.0` | `>=3.9,<3.12` |
| `0.0.17` | `>=0.0.20,<0.0.25` | `>=1.22,<1.27` | `>=1.11,<2.2` | `>=3.9,<3.12` |
| `0.0.16` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |
| `0.0.15` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |
| `0.0.14` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |
| `0.0.13` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |
<details>
<summary>older versions</summary>
| `redcat` | `coola` | `numpy` | `torch` | `python` |
|----------|--------------------|----------------|---------------|---------------|
| `0.0.12` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |
| `0.0.11` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |
| `0.0.10` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |
| `0.0.9` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |
| `0.0.8` | `>=0.0.20,<0.0.21` | `>=1.21,<1.26` | `>=1.11,<2.1` | `>=3.9,<3.12` |
</details>
## Contributing
Please check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).
## API stability
:warning: While `redcat` 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 `redcat` to a new version will possibly break any code that
was using the old version of `redcat`.
## License
`redcat` is licensed under BSD 3-Clause "New" or "Revised" license available in [LICENSE](LICENSE)
file.
---
*The logo was generated with [Fooocus](https://github.com/lllyasviel/Fooocus)*
Raw data
{
"_id": null,
"home_page": "https://github.com/durandtibo/redcat",
"name": "redcat",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<3.12",
"maintainer_email": "",
"keywords": "batch",
"author": "Thibaut Durand",
"author_email": "durand.tibo+gh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/15/79/057c4219e39182a78907ff4183d723518af1c1ae608d11714c883fbb360b/redcat-0.0.18.tar.gz",
"platform": null,
"description": "# redcat\n\n<p align=\"center\">\n <a href=\"https://github.com/durandtibo/redcat/actions\">\n <img alt=\"CI\" src=\"https://github.com/durandtibo/redcat/workflows/CI/badge.svg\">\n </a>\n <a href=\"https://durandtibo.github.io/redcat/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/redcat/workflows/Documentation/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/redcat/actions\">\n <img alt=\"Nightly Tests\" src=\"https://github.com/durandtibo/redcat/workflows/Nightly%20Tests/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/redcat/actions\">\n <img alt=\"Nightly Package Tests\" src=\"https://github.com/durandtibo/redcat/workflows/Nightly%20Package%20Tests/badge.svg\">\n </a>\n <br/>\n <a href=\"https://codecov.io/gh/durandtibo/redcat\">\n <img alt=\"Codecov\" src=\"https://codecov.io/gh/durandtibo/redcat/branch/main/graph/badge.svg\">\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/redcat/maintainability\">\n <img src=\"https://api.codeclimate.com/v1/badges/0987ab26fe4d52025085/maintainability\" />\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/redcat/test_coverage\">\n <img src=\"https://api.codeclimate.com/v1/badges/0987ab26fe4d52025085/test_coverage\" />\n </a>\n <br/>\n <a href=\"https://pypi.org/project/redcat/\">\n <img alt=\"PYPI version\" src=\"https://img.shields.io/pypi/v/redcat\">\n </a>\n <a href=\"https://pypi.org/project/redcat/\">\n <img alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/redcat.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/redcat\">\n </a>\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 <br/>\n <a href=\"https://pepy.tech/project/redcat\">\n <img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/redcat\">\n </a>\n <a href=\"https://pepy.tech/project/redcat\">\n <img alt=\"Monthly downloads\" src=\"https://static.pepy.tech/badge/redcat/month\">\n </a>\n <br/>\n</p>\n\n<p align=\"center\">\n<img height=\"242\" src=\"assets/redcat.png\" alt=\"logo\"/>\n</p>\n\n\n\n---\n\n## Philosophy\n\n- `BatchedTensor` and `BatchedTensorSeq` must behave like `torch.Tensor`\n- `BatchedArray` and `BatchedArraySeq` must behave like `numpy.ndarray`\n- `BatchedTensor` (resp. `BatchedTensorSeq`) does not have to behave like `BatchedArray` (\n resp. `BatchedArraySeq`)\n\n## Installation\n\nWe highly recommend installing\na [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).\n`redcat` can be installed from pip using the following command:\n\n```shell\npip install redcat\n```\n\nTo make the package as slim as possible, only the minimal packages required to use `redcat` are\ninstalled.\nTo include all the dependencies, you can use the following command:\n\n```shell\npip install redcat[all]\n```\n\nPlease check the [get started page](https://durandtibo.github.io/redcat/get_started) to see how to\ninstall only some specific dependencies or other alternatives to install the library.\nThe following is the corresponding `redcat` versions and supported Python, PyTorch and NumPy\nversions.\n\n| `redcat` | `coola` | `numpy` | `torch` | `python` |\n|----------|--------------------|----------------|---------------|---------------|\n| `main` | `>=0.0.20,<0.2` | `>=1.22,<2.0` | `>=1.11,<3.0` | `>=3.9,<3.12` |\n| `0.0.17` | `>=0.0.20,<0.0.25` | `>=1.22,<1.27` | `>=1.11,<2.2` | `>=3.9,<3.12` |\n| `0.0.16` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |\n| `0.0.15` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |\n| `0.0.14` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |\n| `0.0.13` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |\n\n<details>\n <summary>older versions</summary>\n\n| `redcat` | `coola` | `numpy` | `torch` | `python` |\n|----------|--------------------|----------------|---------------|---------------|\n| `0.0.12` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |\n| `0.0.11` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |\n| `0.0.10` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |\n| `0.0.9` | `>=0.0.20,<0.0.24` | `>=1.22,<1.27` | `>=1.11,<2.1` | `>=3.9,<3.12` |\n| `0.0.8` | `>=0.0.20,<0.0.21` | `>=1.21,<1.26` | `>=1.11,<2.1` | `>=3.9,<3.12` |\n\n</details>\n\n## Contributing\n\nPlease check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).\n\n## API stability\n\n:warning: While `redcat` 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 `redcat` to a new version will possibly break any code that\nwas using the old version of `redcat`.\n\n## License\n\n`redcat` is licensed under BSD 3-Clause \"New\" or \"Revised\" license available in [LICENSE](LICENSE)\nfile.\n\n---\n\n*The logo was generated with [Fooocus](https://github.com/lllyasviel/Fooocus)*\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A library to manipulate batches of examples",
"version": "0.0.18",
"project_urls": {
"Homepage": "https://github.com/durandtibo/redcat",
"Repository": "https://github.com/durandtibo/redcat"
},
"split_keywords": [
"batch"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e13641daf47bf2bffe184e370d37ade8cb8680166fdd6b7e4e0f191f39e51ca0",
"md5": "af64edc478641e80d906a492fe31fa20",
"sha256": "42598d58c8cc47e0b26e88a4598645e4326c32e8986237f33b6ccfa780a5f947"
},
"downloads": -1,
"filename": "redcat-0.0.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af64edc478641e80d906a492fe31fa20",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.12",
"size": 57711,
"upload_time": "2023-12-16T21:36:41",
"upload_time_iso_8601": "2023-12-16T21:36:41.163828Z",
"url": "https://files.pythonhosted.org/packages/e1/36/41daf47bf2bffe184e370d37ade8cb8680166fdd6b7e4e0f191f39e51ca0/redcat-0.0.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1579057c4219e39182a78907ff4183d723518af1c1ae608d11714c883fbb360b",
"md5": "2bbb17d8a5e236fedf2a0bb6d811edf6",
"sha256": "fc43f5796b6d3b45a8970a7aae0f7dcd4382947f559640be93dbcc4cf5ee74a7"
},
"downloads": -1,
"filename": "redcat-0.0.18.tar.gz",
"has_sig": false,
"md5_digest": "2bbb17d8a5e236fedf2a0bb6d811edf6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.12",
"size": 49615,
"upload_time": "2023-12-16T21:36:42",
"upload_time_iso_8601": "2023-12-16T21:36:42.926830Z",
"url": "https://files.pythonhosted.org/packages/15/79/057c4219e39182a78907ff4183d723518af1c1ae608d11714c883fbb360b/redcat-0.0.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-16 21:36:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "durandtibo",
"github_project": "redcat",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "redcat"
}
JSON
