https://github.com/durandtibo/gravitorch-accelerate
Extension to use accelerate with gravitorch
https://github.com/durandtibo/gravitorch-accelerate
Last synced: about 2 months ago
JSON representation
Extension to use accelerate with gravitorch
- Host: GitHub
- URL: https://github.com/durandtibo/gravitorch-accelerate
- Owner: durandtibo
- License: bsd-3-clause
- Created: 2023-10-10T03:22:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-22T08:50:35.000Z (over 1 year ago)
- Last Synced: 2024-04-24T19:23:52.931Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 438 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# gravitorch-accelerate
## Overview
Plugin to use `accelerate` with `gravitorch`.
- [Documentation](https://durandtibo.github.io/gtaccelerate/)
- [Installation](#installation)
- [Contributing](#contributing)
- [API stability](#api-stability)
- [License](#license)
## Installation
We highly recommend installing
a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
`gtaccelerate` can be installed from pip using the following command:
```shell
pip install gtaccelerate
```
To make the package as slim as possible, only the minimal packages required to use `gtaccelerate`
are
installed.
To include all the dependencies, you can use the following command:
```shell
pip install gtaccelerate[all]
```
Please check the [get started page](https://durandtibo.github.io/gtaccelerate/get_started) to see
how to install only some specific dependencies or other alternatives to install the library.
The following is the corresponding `gtaccelerate` versions and supported dependencies.
| `gtaccelerate` | `accelerate` | `gravitorch` | `torch` | `python` |
|----------------|----------------|--------------------|------------------|---------------|
| `main` | `>=0.20,<0.25` | `>=0.0.23,<0.0.24` | `>=2.0.0,<2.2.0` | `>=3.9,<3.12` |
* 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/gtaccelerate/issues).
We will reply to you as soon as possible. Thank you very much.
## API stability
:warning: While `gtaccelerate` 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 `gtaccelerate` to a new version will possibly break any code
that was using the old version of `gtaccelerate`.
## License
`gtaccelerate` is licensed under BSD 3-Clause "New" or "Revised" license available
in [LICENSE](LICENSE) file.