Metadata-Version: 2.1
Name: ai-helpers-pytorch-utils
Version: 0.1.0a0
Summary: Common pytorch utils
Author: Corentin Vasseur
Author-email: vasseur.corentin@gmail.com
Requires-Python: >=3.10,<3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: numpy (==1.26.4)
Requires-Dist: pandas (==2.0.3)
Requires-Dist: plotly (>=5.14.1,<6.0.0)
Requires-Dist: pytorch-lightning (>=2.1.3,<3.0.0)
Requires-Dist: scikit-learn (==1.3.2)
Requires-Dist: torch (==2.2.2)
Requires-Dist: torchinfo (>=1.8.0,<2.0.0)
Description-Content-Type: text/markdown

# AI Helpers - Pytorch Utils

`pytorch-utils` is a Python module that provides a collection of utilities to simplify and enhance the use of PyTorch. These utilities are designed to make working with PyTorch more efficient and to reduce boilerplate code.

> TODO: tests & export logging

## Table of Contents

- [AI Helpers - Pytorch Utils](#ai-helpers---pytorch-utils)
  - [Table of Contents](#table-of-contents)
  - [Installation](#installation)
  - [Getting Started](#getting-started)
  - [Utilities](#utilities)
  - [Examples](#examples)
  - [Contributing](#contributing)

## Installation

You can install the `pytorch-utils` module via pip:

```bash
pip install pytorch-utils
```

## Getting Started

First, import the module in your Python script:

```python
import pytorch_utils as pu
```

Now you can use the utilities provided by `pytorch-utils`.

## Utilities
 > TODO

## Examples
 > TODO

## Contributing

We welcome contributions to `pytorch-utils`. To contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -am 'Add some feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Create a new Pull Request.

Please ensure your code follows the project's coding standards and includes appropriate tests.
