Metadata-Version: 2.1
Name: torchjd
Version: 0.1.0
Summary: Library for Jacobian Descent with PyTorch.
Author-email: Valerian Rey <valerian.rey@gmail.com>, Pierre Quinton <pierre.quinton@gmail.com>
Project-URL: Homepage, https://torchjd.org/
Project-URL: Documentation, https://torchjd.org/
Project-URL: Source, https://github.com/TorchJD/torchjd
Project-URL: Changelog, https://github.com/TorchJD/torchjd/blob/main/CHANGELOG.md
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch >=2.0.0
Requires-Dist: quadprog !=0.1.10,>=0.1.9
Requires-Dist: numpy <2.0.0,>=1.21.0
Requires-Dist: qpsolvers >=1.0.1
Requires-Dist: cvxpy >=1.3.0

# ![image](docs/source/icons/favicon-32x32.png) TorchJD

TorchJD is a library enabling Jacobian descent with PyTorch, for optimization of neural networks
with multiple objectives.

> [!IMPORTANT]
> This library is currently in an early development stage. The API is subject to significant changes
> in future versions. Use with caution in production environments and be prepared for potential
> breaking changes in upcoming releases.

## Installation
<!-- start installation -->
TorchJD can be installed directly with pip:
```bash
pip install torchjd
```
<!-- end installation -->

## Compatibility
TorchJD requires python 3.10, 3.11 or 3.12. It is only compatible with recent versions of PyTorch
(>= 2.0). For more information, read the `dependencies` in [pyproject.toml](./pyproject.toml).

## Contribution

Please read the [Contribution page](CONTRIBUTING.md).
