# gravitorch-accelerate
<p align="center">
<a href="https://github.com/durandtibo/gravitorch-accelerate/actions">
<img alt="CI" src="https://github.com/durandtibo/gravitorch-accelerate/workflows/CI/badge.svg">
</a>
<a href="https://durandtibo.github.io/gravitorch-accelerate/">
<img alt="Documentation" src="https://github.com/durandtibo/gravitorch-accelerate/workflows/Documentation/badge.svg">
</a>
<a href="https://github.com/durandtibo/gravitorch-accelerate/actions">
<img alt="Nightly Tests" src="https://github.com/durandtibo/gravitorch-accelerate/workflows/Nightly%20Tests/badge.svg">
</a>
<a href="https://github.com/durandtibo/gravitorch-accelerate/actions">
<img alt="Nightly Package Tests" src="https://github.com/durandtibo/gravitorch-accelerate/workflows/Nightly%20Package%20Tests/badge.svg">
</a>
<br/>
<a href="https://codecov.io/gh/durandtibo/gravitorch-accelerate">
<img alt="Codecov" src="https://codecov.io/gh/durandtibo/gravitorch-accelerate/branch/main/graph/badge.svg">
</a>
<a href="https://codeclimate.com/github/durandtibo/gravitorch-accelerate/maintainability">
<img src="https://api.codeclimate.com/v1/badges/d7b549a77d7869aa1349/maintainability" />
</a>
<a href="https://codeclimate.com/github/durandtibo/gravitorch-accelerate/test_coverage">
<img src="https://api.codeclimate.com/v1/badges/d7b549a77d7869aa1349/test_coverage" />
</a>
<br/>
<a href="https://pypi.org/project/gtaccelerate/">
<img alt="PYPI version" src="https://img.shields.io/pypi/v/gtaccelerate">
</a>
<a href="https://pypi.org/project/gtaccelerate/">
<img alt="Python" src="https://img.shields.io/pypi/pyversions/gtaccelerate.svg">
</a>
<a href="https://opensource.org/licenses/BSD-3-Clause">
<img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/gtaccelerate">
</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/gtaccelerate">
<img alt="Downloads" src="https://static.pepy.tech/badge/gtaccelerate">
</a>
<a href="https://pepy.tech/project/gtaccelerate">
<img alt="Monthly downloads" src="https://static.pepy.tech/badge/gtaccelerate/month">
</a>
<br/>
</p>
## 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` |
<sup>*</sup> 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/durandtibo/gravitorch-accelerate",
"name": "gtaccelerate",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<3.12",
"maintainer_email": "",
"keywords": "pytorch,accelerate,gravitorch",
"author": "Thibaut Durand",
"author_email": "durand.tibo+gh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/eb/3c/69b18976c572974c878d94f27165a965f5f8c017d4c2d522473768c5df22/gtaccelerate-0.0.1a6.tar.gz",
"platform": null,
"description": "# gravitorch-accelerate\n\n<p align=\"center\">\n <a href=\"https://github.com/durandtibo/gravitorch-accelerate/actions\">\n <img alt=\"CI\" src=\"https://github.com/durandtibo/gravitorch-accelerate/workflows/CI/badge.svg\">\n </a>\n <a href=\"https://durandtibo.github.io/gravitorch-accelerate/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/gravitorch-accelerate/workflows/Documentation/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/gravitorch-accelerate/actions\">\n <img alt=\"Nightly Tests\" src=\"https://github.com/durandtibo/gravitorch-accelerate/workflows/Nightly%20Tests/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/gravitorch-accelerate/actions\">\n <img alt=\"Nightly Package Tests\" src=\"https://github.com/durandtibo/gravitorch-accelerate/workflows/Nightly%20Package%20Tests/badge.svg\">\n </a>\n <br/>\n <a href=\"https://codecov.io/gh/durandtibo/gravitorch-accelerate\">\n <img alt=\"Codecov\" src=\"https://codecov.io/gh/durandtibo/gravitorch-accelerate/branch/main/graph/badge.svg\">\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/gravitorch-accelerate/maintainability\">\n <img src=\"https://api.codeclimate.com/v1/badges/d7b549a77d7869aa1349/maintainability\" />\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/gravitorch-accelerate/test_coverage\">\n <img src=\"https://api.codeclimate.com/v1/badges/d7b549a77d7869aa1349/test_coverage\" />\n </a>\n <br/>\n <a href=\"https://pypi.org/project/gtaccelerate/\">\n <img alt=\"PYPI version\" src=\"https://img.shields.io/pypi/v/gtaccelerate\">\n </a>\n <a href=\"https://pypi.org/project/gtaccelerate/\">\n <img alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/gtaccelerate.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/gtaccelerate\">\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/gtaccelerate\">\n <img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/gtaccelerate\">\n </a>\n <a href=\"https://pepy.tech/project/gtaccelerate\">\n <img alt=\"Monthly downloads\" src=\"https://static.pepy.tech/badge/gtaccelerate/month\">\n </a>\n <br/>\n</p>\n\n## Overview\n\nPlugin to use `accelerate` with `gravitorch`.\n\n- [Documentation](https://durandtibo.github.io/gtaccelerate/)\n- [Installation](#installation)\n- [Contributing](#contributing)\n- [API stability](#api-stability)\n- [License](#license)\n\n## Installation\n\nWe highly recommend installing\na [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).\n`gtaccelerate` can be installed from pip using the following command:\n\n```shell\npip install gtaccelerate\n```\n\nTo make the package as slim as possible, only the minimal packages required to use `gtaccelerate`\nare\ninstalled.\nTo include all the dependencies, you can use the following command:\n\n```shell\npip install gtaccelerate[all]\n```\n\nPlease check the [get started page](https://durandtibo.github.io/gtaccelerate/get_started) to see\nhow to install only some specific dependencies or other alternatives to install the library.\nThe following is the corresponding `gtaccelerate` versions and supported dependencies.\n\n| `gtaccelerate` | `accelerate` | `gravitorch` | `torch` | `python` |\n|----------------|----------------|--------------------|------------------|---------------|\n| `main` | `>=0.20,<0.25` | `>=0.0.23,<0.0.24` | `>=2.0.0,<2.2.0` | `>=3.9,<3.12` |\n\n<sup>*</sup> indicates an optional dependency\n\n## Contributing\n\nPlease check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).\n\n## Suggestions and Communication\n\nEveryone is welcome to contribute to the community.\nIf you have any questions or suggestions, you can\nsubmit [Github Issues](https://github.com/durandtibo/gtaccelerate/issues).\nWe will reply to you as soon as possible. Thank you very much.\n\n## API stability\n\n:warning: While `gtaccelerate` 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 `gtaccelerate` to a new version will possibly break any code\nthat was using the old version of `gtaccelerate`.\n\n## License\n\n`gtaccelerate` is licensed under BSD 3-Clause \"New\" or \"Revised\" license available\nin [LICENSE](LICENSE) file.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Plugin to use accelerate with gravitorch",
"version": "0.0.1a6",
"project_urls": {
"Homepage": "https://github.com/durandtibo/gravitorch-accelerate",
"Repository": "https://github.com/durandtibo/gravitorch-accelerate"
},
"split_keywords": [
"pytorch",
"accelerate",
"gravitorch"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bcb9de9f8ede269acf8edbc229dff047deb98fe782155b6057e44b464cea25ca",
"md5": "5d686b288ea824dce085bf483a0efda6",
"sha256": "d4b3ebe47d8546db85d33a78e651c9df493109f4ba9118645b38ac95684cdcda"
},
"downloads": -1,
"filename": "gtaccelerate-0.0.1a6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d686b288ea824dce085bf483a0efda6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.12",
"size": 8831,
"upload_time": "2023-11-24T23:45:21",
"upload_time_iso_8601": "2023-11-24T23:45:21.563778Z",
"url": "https://files.pythonhosted.org/packages/bc/b9/de9f8ede269acf8edbc229dff047deb98fe782155b6057e44b464cea25ca/gtaccelerate-0.0.1a6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb3c69b18976c572974c878d94f27165a965f5f8c017d4c2d522473768c5df22",
"md5": "ec2fc7c0d7380c81e96104226e7f64f1",
"sha256": "0a61406d4110f97a2b4d0ff0012700d7556d37bf83a5e07ee291dee66cea5c1f"
},
"downloads": -1,
"filename": "gtaccelerate-0.0.1a6.tar.gz",
"has_sig": false,
"md5_digest": "ec2fc7c0d7380c81e96104226e7f64f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.12",
"size": 8806,
"upload_time": "2023-11-24T23:45:23",
"upload_time_iso_8601": "2023-11-24T23:45:23.123875Z",
"url": "https://files.pythonhosted.org/packages/eb/3c/69b18976c572974c878d94f27165a965f5f8c017d4c2d522473768c5df22/gtaccelerate-0.0.1a6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-24 23:45:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "durandtibo",
"github_project": "gravitorch-accelerate",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gtaccelerate"
}
JSON
