Metadata-Version: 2.1
Name: batchtensor
Version: 0.0.1a4
Summary: Functions to manipulate batches of PyTorch tensors
Home-page: https://github.com/durandtibo/batchtensor
License: BSD-3-Clause
Keywords: batch,sequence,pytorch,tensor
Author: Thibaut Durand
Author-email: durand.tibo+gh@gmail.com
Requires-Python: >=3.9,<3.12
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Provides-Extra: all
Requires-Dist: coola (>=0.1,<0.4)
Requires-Dist: torch (>=1.11,<3.0)
Project-URL: Repository, https://github.com/durandtibo/batchtensor
Description-Content-Type: text/markdown

# batchtensor

<p align="center">
    <a href="https://github.com/durandtibo/batchtensor/actions">
        <img alt="CI" src="https://github.com/durandtibo/batchtensor/workflows/CI/badge.svg">
    </a>
    <a href="https://durandtibo.github.io/batchtensor/">
        <img alt="Documentation" src="https://github.com/durandtibo/batchtensor/workflows/Documentation/badge.svg">
    </a>
    <a href="https://github.com/durandtibo/batchtensor/actions">
        <img alt="Nightly Tests" src="https://github.com/durandtibo/batchtensor/workflows/Nightly%20Tests/badge.svg">
    </a>
    <a href="https://github.com/durandtibo/batchtensor/actions">
        <img alt="Nightly Package Tests" src="https://github.com/durandtibo/batchtensor/workflows/Nightly%20Package%20Tests/badge.svg">
    </a>
    <br/>
    <a href="https://codecov.io/gh/durandtibo/batchtensor">
        <img alt="Codecov" src="https://codecov.io/gh/durandtibo/batchtensor/branch/main/graph/badge.svg">
    </a>
    <a href="https://codeclimate.com/github/durandtibo/batchtensor/maintainability">
        <img src="https://api.codeclimate.com/v1/badges/148edc26add138d04928/maintainability" />
    </a>
    <a href="https://codeclimate.com/github/durandtibo/batchtensor/test_coverage">
        <img src="https://api.codeclimate.com/v1/badges/148edc26add138d04928/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/batchtensor/">
        <img alt="PYPI version" src="https://img.shields.io/pypi/v/batchtensor">
    </a>
    <a href="https://pypi.org/project/batchtensor/">
        <img alt="Python" src="https://img.shields.io/pypi/pyversions/batchtensor.svg">
    </a>
    <a href="https://opensource.org/licenses/BSD-3-Clause">
        <img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/batchtensor">
    </a>
    <br/>
    <a href="https://pepy.tech/project/batchtensor">
        <img  alt="Downloads" src="https://static.pepy.tech/badge/batchtensor">
    </a>
    <a href="https://pepy.tech/project/batchtensor">
        <img  alt="Monthly downloads" src="https://static.pepy.tech/badge/batchtensor/month">
    </a>
    <br/>
</p>

## Overview

Functions to manipulate batches of PyTorch tensors

## Installation

We highly recommend installing
a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
`batchtensor` can be installed from pip using the following command:

```shell
pip install batchtensor
```

To make the package as slim as possible, only the minimal packages required to use `batchtensor` are
installed.
To include all the dependencies, you can use the following command:

```shell
pip install batchtensor[all]
```

Please check the [get started page](https://durandtibo.github.io/batchtensor/get_started) to see how
to
install only some specific dependencies or other alternatives to install the library.
The following is the corresponding `batchtensor` versions and tested dependencies.

| `batchtensor` | `coola`      | `torch`       | `python`      |
|---------------|--------------|---------------|---------------|
| `main`        | `>=0.1,<0.4` | `>=1.11,<3.0` | `>=3.9,<3.13` |

<sup>*</sup> indicates an optional dependency

