<div align="center">
<img src="https://github.com/speediedan/finetuning-scheduler/raw/v2.2.1/docs/source/_static/images/logos/logo_fts.png" width="401px">
**A PyTorch Lightning extension that enhances model experimentation with flexible fine-tuning schedules.**
______________________________________________________________________
<p align="center">
<a href="https://finetuning-scheduler.readthedocs.io/en/stable/">Docs</a> •
<a href="#Setup">Setup</a> •
<a href="#examples">Examples</a> •
<a href="#community">Community</a>
</p>
[](https://pypi.org/project/finetuning-scheduler/)
[](https://badge.fury.io/py/finetuning-scheduler)\
[](https://codecov.io/gh/speediedan/finetuning-scheduler)
[](https://finetuning-scheduler.readthedocs.io/en/stable/)
[](https://zenodo.org/badge/latestdoi/455666112)
[](https://github.com/speediedan/finetuning-scheduler/blob/master/LICENSE)
</div>
______________________________________________________________________
<img width="300px" src="https://github.com/speediedan/finetuning-scheduler/raw/v2.2.1/docs/source/_static/images/fts/fts_explicit_loss_anim.gif" alt="FinetuningScheduler explicit loss animation" align="right"/>
[FinetuningScheduler](https://finetuning-scheduler.readthedocs.io/en/stable/api/finetuning_scheduler.fts.html#finetuning_scheduler.fts.FinetuningScheduler) is simple to use yet powerful, offering a number of features that facilitate model research and exploration:
- easy specification of flexible fine-tuning schedules with explicit or regex-based parameter selection
- implicit schedules for initial/naive model exploration
- explicit schedules for performance tuning, fine-grained behavioral experimentation and computational efficiency
- automatic restoration of best per-phase checkpoints driven by iterative application of early-stopping criteria to each fine-tuning phase
- composition of early-stopping and manually-set epoch-driven fine-tuning phase transitions
______________________________________________________________________
## Setup
### Step 0: Install from PyPI
```bash
pip install finetuning-scheduler
```
<!-- -->
### Step 1: Import the FinetuningScheduler callback and start fine-tuning!
```python
import lightning as L
from finetuning_scheduler import FinetuningScheduler
trainer = L.Trainer(callbacks=[FinetuningScheduler()])
```
Get started by following [the Fine-Tuning Scheduler introduction](https://finetuning-scheduler.readthedocs.io/en/stable/index.html) which includes a [CLI-based example](https://finetuning-scheduler.readthedocs.io/en/stable/index.html#example-scheduled-fine-tuning-for-superglue) or by following the [notebook-based](https://pytorch-lightning.readthedocs.io/en/stable/notebooks/lightning_examples/finetuning-scheduler.html) Fine-Tuning Scheduler tutorial.
______________________________________________________________________
### Installation Using the Standalone `pytorch-lightning` Package
*applicable to versions >= `2.0.0`*
Now that the core Lightning package is `lightning` rather than `pytorch-lightning`, Fine-Tuning Scheduler (FTS) by default depends upon the `lightning` package rather than the standalone `pytorch-lightning`. If you would like to continue to use FTS with the standalone `pytorch-lightning` package instead, you can still do so as follows:
Install a given FTS release (for example v2.0.0) using standalone `pytorch-lightning`:
```bash
export FTS_VERSION=2.0.0
export PACKAGE_NAME=pytorch
wget https://github.com/speediedan/finetuning-scheduler/releases/download/v${FTS_VERSION}/finetuning-scheduler-${FTS_VERSION}.tar.gz
pip install finetuning-scheduler-${FTS_VERSION}.tar.gz
```
______________________________________________________________________
## Examples
### Scheduled Fine-Tuning For SuperGLUE
- [Notebook-based Tutorial](https://pytorch-lightning.readthedocs.io/en/stable/notebooks/lightning_examples/finetuning-scheduler.html)
- [CLI-based Tutorial](https://finetuning-scheduler.readthedocs.io/en/stable/#example-scheduled-fine-tuning-for-superglue)
- [FSDP Scheduled Fine-Tuning](https://finetuning-scheduler.readthedocs.io/en/stable/advanced/fsdp_scheduled_fine_tuning.html)
- [LR Scheduler Reinitialization](https://finetuning-scheduler.readthedocs.io/en/stable/advanced/lr_scheduler_reinitialization.html) (advanced)
- [Optimizer Reinitialization](https://finetuning-scheduler.readthedocs.io/en/stable/advanced/optimizer_reinitialization.html) (advanced)
______________________________________________________________________
## Continuous Integration
Fine-Tuning Scheduler is rigorously tested across multiple CPUs, GPUs and against major Python and PyTorch versions. Each Fine-Tuning Scheduler minor release (major.minor.patch) is paired with a Lightning minor release (e.g. Fine-Tuning Scheduler 2.0 depends upon Lightning 2.0).
To ensure maximum stability, the latest Lightning patch release fully tested with Fine-Tuning Scheduler is set as a maximum dependency in Fine-Tuning Scheduler's requirements.txt (e.g. \<= 1.7.1). If you'd like to test a specific Lightning patch version greater than that currently in Fine-Tuning Scheduler's requirements.txt, it will likely work but you should install Fine-Tuning Scheduler from source and update the requirements.txt as desired.
<details>
<summary>Current build statuses for Fine-Tuning Scheduler </summary>
| System / (PyTorch/Python ver) | 1.13/3.8 | 2.2.1/3.8, 2.2.1/3.11 |
| :---------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Linux \[GPUs\*\*\] | - | [](https://dev.azure.com/speediedan/finetuning-scheduler/_build/latest?definitionId=2&branchName=refs%2Ftags%2F2.2.1) |
| Linux (Ubuntu 20.04) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) |
| OSX (11) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) |
| Windows (2022) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) |
- \*\* tests run on one RTX 4090 and one RTX 2070
</details>
## Community
Fine-Tuning Scheduler is developed and maintained by the community in close communication with the [Lightning team](https://pytorch-lightning.readthedocs.io/en/stable/governance.html). Thanks to everyone in the community for their tireless effort building and improving the immensely useful core Lightning project.
PR's welcome! Please see the [contributing guidelines](https://finetuning-scheduler.readthedocs.io/en/stable/generated/CONTRIBUTING.html) (which are essentially the same as Lightning's).
______________________________________________________________________
## Citing Fine-Tuning Scheduler
Please cite:
```tex
@misc{Dan_Dale_2022_6463952,
author = {Dan Dale},
title = {{Fine-Tuning Scheduler}},
month = Feb,
year = 2022,
doi = {10.5281/zenodo.6463952},
publisher = {Zenodo},
url = {https://zenodo.org/record/6463952}
}
```
Feel free to star the repo as well if you find it useful or interesting. Thanks 😊!
Raw data
{
"_id": null,
"home_page": "https://github.com/speediedan/finetuning-scheduler",
"name": "finetuning-scheduler",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "deep learning,pytorch,AI,machine learning,pytorch-lightning,lightning,fine-tuning,finetuning",
"author": "Dan Dale",
"author_email": "danny.dale@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ed/a7/fb92ce00dcafbaf9814fb28b3ab4fc62727f9db4f5346c2a325270df8327/finetuning-scheduler-2.2.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n<img src=\"https://github.com/speediedan/finetuning-scheduler/raw/v2.2.1/docs/source/_static/images/logos/logo_fts.png\" width=\"401px\">\n\n**A PyTorch Lightning extension that enhances model experimentation with flexible fine-tuning schedules.**\n\n______________________________________________________________________\n\n<p align=\"center\">\n <a href=\"https://finetuning-scheduler.readthedocs.io/en/stable/\">Docs</a> \u2022\n <a href=\"#Setup\">Setup</a> \u2022\n <a href=\"#examples\">Examples</a> \u2022\n <a href=\"#community\">Community</a>\n</p>\n\n[](https://pypi.org/project/finetuning-scheduler/)\n[](https://badge.fury.io/py/finetuning-scheduler)\\\n[](https://codecov.io/gh/speediedan/finetuning-scheduler)\n[](https://finetuning-scheduler.readthedocs.io/en/stable/)\n[](https://zenodo.org/badge/latestdoi/455666112)\n[](https://github.com/speediedan/finetuning-scheduler/blob/master/LICENSE)\n\n</div>\n\n______________________________________________________________________\n\n<img width=\"300px\" src=\"https://github.com/speediedan/finetuning-scheduler/raw/v2.2.1/docs/source/_static/images/fts/fts_explicit_loss_anim.gif\" alt=\"FinetuningScheduler explicit loss animation\" align=\"right\"/>\n\n[FinetuningScheduler](https://finetuning-scheduler.readthedocs.io/en/stable/api/finetuning_scheduler.fts.html#finetuning_scheduler.fts.FinetuningScheduler) is simple to use yet powerful, offering a number of features that facilitate model research and exploration:\n\n- easy specification of flexible fine-tuning schedules with explicit or regex-based parameter selection\n - implicit schedules for initial/naive model exploration\n - explicit schedules for performance tuning, fine-grained behavioral experimentation and computational efficiency\n- automatic restoration of best per-phase checkpoints driven by iterative application of early-stopping criteria to each fine-tuning phase\n- composition of early-stopping and manually-set epoch-driven fine-tuning phase transitions\n\n______________________________________________________________________\n\n## Setup\n\n### Step 0: Install from PyPI\n\n```bash\npip install finetuning-scheduler\n```\n\n<!-- -->\n\n### Step 1: Import the FinetuningScheduler callback and start fine-tuning!\n\n```python\nimport lightning as L\nfrom finetuning_scheduler import FinetuningScheduler\n\ntrainer = L.Trainer(callbacks=[FinetuningScheduler()])\n```\n\nGet started by following [the Fine-Tuning Scheduler introduction](https://finetuning-scheduler.readthedocs.io/en/stable/index.html) which includes a [CLI-based example](https://finetuning-scheduler.readthedocs.io/en/stable/index.html#example-scheduled-fine-tuning-for-superglue) or by following the [notebook-based](https://pytorch-lightning.readthedocs.io/en/stable/notebooks/lightning_examples/finetuning-scheduler.html) Fine-Tuning Scheduler tutorial.\n\n______________________________________________________________________\n\n### Installation Using the Standalone `pytorch-lightning` Package\n\n*applicable to versions >= `2.0.0`*\n\nNow that the core Lightning package is `lightning` rather than `pytorch-lightning`, Fine-Tuning Scheduler (FTS) by default depends upon the `lightning` package rather than the standalone `pytorch-lightning`. If you would like to continue to use FTS with the standalone `pytorch-lightning` package instead, you can still do so as follows:\n\nInstall a given FTS release (for example v2.0.0) using standalone `pytorch-lightning`:\n\n```bash\nexport FTS_VERSION=2.0.0\nexport PACKAGE_NAME=pytorch\nwget https://github.com/speediedan/finetuning-scheduler/releases/download/v${FTS_VERSION}/finetuning-scheduler-${FTS_VERSION}.tar.gz\npip install finetuning-scheduler-${FTS_VERSION}.tar.gz\n```\n\n______________________________________________________________________\n\n## Examples\n\n### Scheduled Fine-Tuning For SuperGLUE\n\n- [Notebook-based Tutorial](https://pytorch-lightning.readthedocs.io/en/stable/notebooks/lightning_examples/finetuning-scheduler.html)\n- [CLI-based Tutorial](https://finetuning-scheduler.readthedocs.io/en/stable/#example-scheduled-fine-tuning-for-superglue)\n- [FSDP Scheduled Fine-Tuning](https://finetuning-scheduler.readthedocs.io/en/stable/advanced/fsdp_scheduled_fine_tuning.html)\n- [LR Scheduler Reinitialization](https://finetuning-scheduler.readthedocs.io/en/stable/advanced/lr_scheduler_reinitialization.html) (advanced)\n- [Optimizer Reinitialization](https://finetuning-scheduler.readthedocs.io/en/stable/advanced/optimizer_reinitialization.html) (advanced)\n\n______________________________________________________________________\n\n## Continuous Integration\n\nFine-Tuning Scheduler is rigorously tested across multiple CPUs, GPUs and against major Python and PyTorch versions. Each Fine-Tuning Scheduler minor release (major.minor.patch) is paired with a Lightning minor release (e.g. Fine-Tuning Scheduler 2.0 depends upon Lightning 2.0).\n\nTo ensure maximum stability, the latest Lightning patch release fully tested with Fine-Tuning Scheduler is set as a maximum dependency in Fine-Tuning Scheduler's requirements.txt (e.g. \\<= 1.7.1). If you'd like to test a specific Lightning patch version greater than that currently in Fine-Tuning Scheduler's requirements.txt, it will likely work but you should install Fine-Tuning Scheduler from source and update the requirements.txt as desired.\n\n<details>\n <summary>Current build statuses for Fine-Tuning Scheduler </summary>\n\n| System / (PyTorch/Python ver) | 1.13/3.8 | 2.2.1/3.8, 2.2.1/3.11 |\n| :---------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |\n| Linux \\[GPUs\\*\\*\\] | - | [](https://dev.azure.com/speediedan/finetuning-scheduler/_build/latest?definitionId=2&branchName=refs%2Ftags%2F2.2.1) |\n| Linux (Ubuntu 20.04) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) |\n| OSX (11) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) |\n| Windows (2022) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) | [](https://github.com/speediedan/finetuning-scheduler/actions/workflows/ci_test-full.yml) |\n\n- \\*\\* tests run on one RTX 4090 and one RTX 2070\n\n</details>\n\n## Community\n\nFine-Tuning Scheduler is developed and maintained by the community in close communication with the [Lightning team](https://pytorch-lightning.readthedocs.io/en/stable/governance.html). Thanks to everyone in the community for their tireless effort building and improving the immensely useful core Lightning project.\n\nPR's welcome! Please see the [contributing guidelines](https://finetuning-scheduler.readthedocs.io/en/stable/generated/CONTRIBUTING.html) (which are essentially the same as Lightning's).\n\n______________________________________________________________________\n\n## Citing Fine-Tuning Scheduler\n\nPlease cite:\n\n```tex\n@misc{Dan_Dale_2022_6463952,\n author = {Dan Dale},\n title = {{Fine-Tuning Scheduler}},\n month = Feb,\n year = 2022,\n doi = {10.5281/zenodo.6463952},\n publisher = {Zenodo},\n url = {https://zenodo.org/record/6463952}\n }\n```\n\nFeel free to star the repo as well if you find it useful or interesting. Thanks \ud83d\ude0a!\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A PyTorch Lightning extension that enhances model experimentation with flexible fine-tuning schedules.",
"version": "2.2.1",
"project_urls": {
"Bug Tracker": "https://github.com/speediedan/finetuning-scheduler/issues",
"Documentation": "https://finetuning-scheduler.readthedocs.io/en/latest/",
"Download": "https://github.com/speediedan/finetuning-scheduler",
"Homepage": "https://github.com/speediedan/finetuning-scheduler",
"Source Code": "https://github.com/speediedan/finetuning-scheduler"
},
"split_keywords": [
"deep learning",
"pytorch",
"ai",
"machine learning",
"pytorch-lightning",
"lightning",
"fine-tuning",
"finetuning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "49461a9c9d59b6f94cf423445dab4fc3beff314415f38cfef8c2b9f68fd4d33c",
"md5": "5c4e347ca930d81e7810d1055a1928e6",
"sha256": "f1ab630b66a16798b5252b048d23f032241c71febdf7f111ac039833544b08fa"
},
"downloads": -1,
"filename": "finetuning_scheduler-2.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c4e347ca930d81e7810d1055a1928e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 90973,
"upload_time": "2024-03-04T22:17:03",
"upload_time_iso_8601": "2024-03-04T22:17:03.083324Z",
"url": "https://files.pythonhosted.org/packages/49/46/1a9c9d59b6f94cf423445dab4fc3beff314415f38cfef8c2b9f68fd4d33c/finetuning_scheduler-2.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eda7fb92ce00dcafbaf9814fb28b3ab4fc62727f9db4f5346c2a325270df8327",
"md5": "ffd62f46e65bc85b671b371a1659932f",
"sha256": "3ecd1c90253d804a11afcad64a9ca8b101701affed6bfccd3e0ff29db0fd9773"
},
"downloads": -1,
"filename": "finetuning-scheduler-2.2.1.tar.gz",
"has_sig": false,
"md5_digest": "ffd62f46e65bc85b671b371a1659932f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 117067,
"upload_time": "2024-03-04T22:17:04",
"upload_time_iso_8601": "2024-03-04T22:17:04.675359Z",
"url": "https://files.pythonhosted.org/packages/ed/a7/fb92ce00dcafbaf9814fb28b3ab4fc62727f9db4f5346c2a325270df8327/finetuning-scheduler-2.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 22:17:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "speediedan",
"github_project": "finetuning-scheduler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "finetuning-scheduler"
}
JSON
