# Lightning ⚡ Colossal-AI
**Efficient Large-Scale Distributed Training with [Colossal-AI](https://colossalai.org/) and [Lightning AI](https://lightning.ai)**
[![lightning](https://img.shields.io/badge/-Lightning_2.0+-792ee5?logo=pytorchlightning&logoColor=white)](https://lightning.ai/)
[![PyPI Status](https://badge.fury.io/py/lightning-colossalai.svg)](https://badge.fury.io/py/lightning-colossalai)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lightning-colossalai)](https://pypi.org/project/lightning-colossalai/)
[![PyPI Status](https://pepy.tech/badge/lightning-colossalai)](https://pepy.tech/project/lightning-colossalai)
[![Deploy Docs](https://github.com/Lightning-AI/lightning-ColossalAI/actions/workflows/docs-deploy.yml/badge.svg)](https://lightning-ai.github.io/lightning-ColossalAI/)
[![General checks](https://github.com/Lightning-AI/lightning-colossalai/actions/workflows/ci-checks.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-colossalai/actions/workflows/ci-checks.yml)
[![CI testing](https://github.com/Lightning-AI/lightning-colossalai/actions/workflows/ci-testing.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-colossalai/actions/workflows/ci-testing.yml)
[![Build Status](https://dev.azure.com/Lightning-AI/compatibility/_apis/build/status/Lightning-AI.lightning-ColossalAI?branchName=main)](https://dev.azure.com/Lightning-AI/compatibility/_build/latest?definitionId=42&branchName=main)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Lightning-AI/lightning-ColossalAI/main.svg)](https://results.pre-commit.ci/latest/github/Lightning-AI/lightning-ColossalAI/main)
______________________________________________________________________
## Installation
```bash
pip install -U lightning-colossalai
```
## Usage
Simply set the strategy argument in the Trainer:
```py
import lightning as L
trainer = L.Trainer(strategy="colossalai", precision="16-mixed", devices=...)
```
For more fine-grained tuning of Colossal-AI's parameters, pass the strategy object to the Trainer:
```py
import lightning as L
from lightning_colossalai import ColossalAIStrategy
strategy = ColossalAIStrategy(...)
trainer = L.Trainer(strategy=strategy, precision="16-mixed", devices=...)
```
Find all configuration options [in the docs](https://lightning.ai/docs/pytorch/latest/advanced/third_party/colossalai.html)!
Raw data
{
"_id": null,
"home_page": "https://github.com/Lightning-AI/lightning-colossalai",
"name": "lightning-colossalai",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "deep learning,pytorch,AI",
"author": "Lightning-AI et al.",
"author_email": "name@lightning.ai",
"download_url": "https://files.pythonhosted.org/packages/2d/5b/59fdfecd68ad119ec923bac3451956239ca403774541e443eda2a2718377/lightning-colossalai-0.1.0.tar.gz",
"platform": null,
"description": "# Lightning \u26a1 Colossal-AI\n\n**Efficient Large-Scale Distributed Training with [Colossal-AI](https://colossalai.org/) and [Lightning AI](https://lightning.ai)**\n\n[![lightning](https://img.shields.io/badge/-Lightning_2.0+-792ee5?logo=pytorchlightning&logoColor=white)](https://lightning.ai/)\n[![PyPI Status](https://badge.fury.io/py/lightning-colossalai.svg)](https://badge.fury.io/py/lightning-colossalai)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lightning-colossalai)](https://pypi.org/project/lightning-colossalai/)\n[![PyPI Status](https://pepy.tech/badge/lightning-colossalai)](https://pepy.tech/project/lightning-colossalai)\n[![Deploy Docs](https://github.com/Lightning-AI/lightning-ColossalAI/actions/workflows/docs-deploy.yml/badge.svg)](https://lightning-ai.github.io/lightning-ColossalAI/)\n\n[![General checks](https://github.com/Lightning-AI/lightning-colossalai/actions/workflows/ci-checks.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-colossalai/actions/workflows/ci-checks.yml)\n[![CI testing](https://github.com/Lightning-AI/lightning-colossalai/actions/workflows/ci-testing.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-colossalai/actions/workflows/ci-testing.yml)\n[![Build Status](https://dev.azure.com/Lightning-AI/compatibility/_apis/build/status/Lightning-AI.lightning-ColossalAI?branchName=main)](https://dev.azure.com/Lightning-AI/compatibility/_build/latest?definitionId=42&branchName=main)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Lightning-AI/lightning-ColossalAI/main.svg)](https://results.pre-commit.ci/latest/github/Lightning-AI/lightning-ColossalAI/main)\n\n______________________________________________________________________\n\n## Installation\n\n```bash\npip install -U lightning-colossalai\n```\n\n## Usage\n\nSimply set the strategy argument in the Trainer:\n\n```py\nimport lightning as L\n\ntrainer = L.Trainer(strategy=\"colossalai\", precision=\"16-mixed\", devices=...)\n```\n\nFor more fine-grained tuning of Colossal-AI's parameters, pass the strategy object to the Trainer:\n\n```py\nimport lightning as L\nfrom lightning_colossalai import ColossalAIStrategy\n\nstrategy = ColossalAIStrategy(...)\ntrainer = L.Trainer(strategy=strategy, precision=\"16-mixed\", devices=...)\n```\n\nFind all configuration options [in the docs](https://lightning.ai/docs/pytorch/latest/advanced/third_party/colossalai.html)!\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Efficient Large-Scale Distributed Training with Colossal-AI and Lightning AI.",
"version": "0.1.0",
"split_keywords": [
"deep learning",
"pytorch",
"ai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc148cb492a6ed13a6712d2ccf01aba4250332d0cdf23835299e6394bdfd5b60",
"md5": "27446c835955d9fe8c2a2e8cb57b957e",
"sha256": "46783c408f52747517a4c28424f03fa3813c5d7accc5aa7d1fed1aac955122a4"
},
"downloads": -1,
"filename": "lightning_colossalai-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "27446c835955d9fe8c2a2e8cb57b957e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14786,
"upload_time": "2023-03-22T07:34:26",
"upload_time_iso_8601": "2023-03-22T07:34:26.569800Z",
"url": "https://files.pythonhosted.org/packages/dc/14/8cb492a6ed13a6712d2ccf01aba4250332d0cdf23835299e6394bdfd5b60/lightning_colossalai-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2d5b59fdfecd68ad119ec923bac3451956239ca403774541e443eda2a2718377",
"md5": "584d585fc2842b83e5311b2273dd9b84",
"sha256": "3e483405012aea6ef8c1d7b9dd04c227dc45ad331f374e6ff3c0ff185f9aaedf"
},
"downloads": -1,
"filename": "lightning-colossalai-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "584d585fc2842b83e5311b2273dd9b84",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15935,
"upload_time": "2023-03-22T07:34:28",
"upload_time_iso_8601": "2023-03-22T07:34:28.033982Z",
"url": "https://files.pythonhosted.org/packages/2d/5b/59fdfecd68ad119ec923bac3451956239ca403774541e443eda2a2718377/lightning-colossalai-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-22 07:34:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Lightning-AI",
"github_project": "lightning-colossalai",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "lightning-colossalai"
}