diff --git a/README.md b/README.md index 649a75f..4f0bcf8 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ OpenDelta is a toolkit for parameter-efficient tuning methods (we dub it as *delta tuning*), by which users could flexibly assign (or add) a small amount parameters to update while keeping the most paramters frozen. By using OpenDelta, users could easily implement prefix-tuning, adapters, Lora, or any other types of delta tuning with preferred PTMs. -- Our repo is tested on Python 3.=-0 and PyTorch 1.9.0. Lower version may also be supported. +- The last version of OpenDelta is tested on Python==3.8.13, PyTorch==1.12.1, transformers==4.22.2. Other versions are likely to be supported as well. If you encounter bugs when using your own package versions, please raise an issue, we will look into it as soon as possible. - **A demo of using Opendelta to modify the PLM (E.g., BART).** ![How PLM changes using Delta-tuning](docs/source/imgs/demo.gif) @@ -162,7 +162,7 @@ delta3.log() ## Verified Default Configurations - **You can try to use OpenDelta on *any* backbone models based on PyTorch.** -- However, with small chances thatThe interface of the submodules of the backbone model is not supported. Therefore we verified some commonly +- However, with small chances that the interface of the submodules of the backbone model is not supported. Therefore we verified some commonly used models that OpenDelta are sure to support. - We will keep testing more and more emerging models. diff --git a/docs/source/conf.py b/docs/source/conf.py index 3731214..1be8e51 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -31,8 +31,8 @@ copyright = '{}, {}, Licenced under the Apache License, Version 2.0'.format(date # The full version, including alpha/beta/rc tags -release = '0.3.0' -version = "0.3.0" +release = '0.3.1' +version = "0.3.1" html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] diff --git a/docs/source/notes/update.md b/docs/source/notes/update.md index 82a98f4..26626d2 100644 --- a/docs/source/notes/update.md +++ b/docs/source/notes/update.md @@ -2,6 +2,7 @@ ## Version 0.3.1 - We update [must_try.py](https://github.com/thunlp/OpenDelta/tree/main/examples/unittest/must_try.py) for a simple introduction of the core functionality of OpenDelta. +- Thanks to [Weilin Zhao](https://github.com/Achazwl) We merge a long-developed branch parallel_adapter into the main branch. ## Version 0.3.0 @@ -25,4 +26,4 @@ ## Version 0.2.4 ### Updates - examples/examples_seq2seq and examples/examples_text-classification is depreciated and moved to [legacy](https://github.com/thunlp/OpenDelta/tree/main/examples/legacies) -- we provide [examples_prompt](https://github.com/thunlp/OpenDelta/tree/main/examples/examples_prompt), as a cleaner and more general framework, which unifies the delta tuning paradigm and the prompt-tuning paradigm. It is still based on [Huggingface Trainers](https://huggingface.co/docs/transformers/main_classes/trainer). In this example framework, the running pipeline is [a unified script](https://github.com/thunlp/OpenDelta/tree/main/examples/examples_prompt/src), the differences in tasks, models, delta tuning models, and even prompt-tuning paradigms are [more modular and be more independent ](https://github.com/thunlp/OpenDelta/tree/main/examples/examples_prompt/backbones). Please try it out! \ No newline at end of file +- Thanks to [Zhen Zhang](https://github.com/namezhenzhang), we provide [examples_prompt](https://github.com/thunlp/OpenDelta/tree/main/examples/examples_prompt), as a cleaner and more general framework, which unifies the delta tuning paradigm and the prompt-tuning paradigm. It is still based on [Huggingface Trainers](https://huggingface.co/docs/transformers/main_classes/trainer). In this example framework, the running pipeline is [a unified script](https://github.com/thunlp/OpenDelta/tree/main/examples/examples_prompt/src), the differences in tasks, models, delta tuning models, and even prompt-tuning paradigms are [more modular and be more independent ](https://github.com/thunlp/OpenDelta/tree/main/examples/examples_prompt/backbones). Please try it out! \ No newline at end of file diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/cola.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/cola.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/cola.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/cola.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/mnli.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/mnli.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/mnli.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/mnli.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/mrpc.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/mrpc.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/mrpc.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/mrpc.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/qnli.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/qnli.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/qnli.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/qnli.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/qqp.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/qqp.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/qqp.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/qqp.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/rte.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/rte.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/rte.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/rte.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/sst2.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/sst2.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/sst2.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/sst2.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/stsb.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/stsb.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/stsb.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/stsb.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-boolq.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-boolq.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-boolq.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-boolq.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-cb.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-cb.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-cb.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-cb.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-copa.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-copa.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-copa.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-copa.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-multirc.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-multirc.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-multirc.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-multirc.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-record.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-record.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-record.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-record.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-wic.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-wic.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-wic.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-wic.json diff --git a/examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-wsc.fixed.json b/examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-wsc.fixed.json similarity index 100% rename from examples/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-wsc.fixed.json rename to examples/legacies/examples_text-classification/configs/parallel_adapter_roberta-base/superglue-wsc.fixed.json diff --git a/setup.py b/setup.py index 7655c1d..27c0313 100644 --- a/setup.py +++ b/setup.py @@ -31,7 +31,7 @@ def get_requirements(): with open('README.md', 'r') as f: setuptools.setup( name = 'opendelta', - version = "0.3.0", + version = "0.3.1", description = "An open source framework for delta learning (parameter efficient learning).", long_description=open("README.md", "r", encoding="utf-8").read(), long_description_content_type="text/markdown",