adapter-transformers

A friendly fork of HuggingFace's Transformers, adding Adapters to PyTorch language models

Note: We're currently developing a newer version of this library on the adapters branch. All new changes will be integrated there. See #584 for details.

adapter-transformers is an extension of HuggingFace's Transformers library, integrating adapters into state-of-the-art language models by incorporating AdapterHub, a central repository for pre-trained adapter modules.

💡 Important: This library can be used as a drop-in replacement for HuggingFace Transformers and regularly synchronizes new upstream changes. Thus, most files in this repository are direct copies from the HuggingFace Transformers source, modified only with changes required for the adapter implementations.

Installation

adapter-transformers currently supports Python 3.8+ and PyTorch 1.12.1+. After installing PyTorch, you can install adapter-transformers from PyPI ...

pip install -U adapter-transformers

... or from source by cloning the repository:

git clone https://github.com/adapter-hub/adapter-transformers.git
cd adapter-transformers
pip install .

Getting Started

HuggingFace's great documentation on getting started with Transformers can be found here. adapter-transformers is fully compatible with Transformers.

To get started with adapters, refer to these locations:

Colab notebook tutorials, a series notebooks providing an introduction to all the main concepts of (adapter-)transformers and AdapterHub
https://docs.adapterhub.ml, our documentation on training and using adapters with adapter-transformers
https://adapterhub.ml to explore available pre-trained adapter modules and share your own adapters
Examples folder of this repository containing HuggingFace's example training scripts, many adapted for training adapters

Implemented Methods

Currently, adapter-transformers integrates all architectures and methods listed below:

Method	Paper(s)	Quick Links
Bottleneck adapters	Houlsby et al. (2019) Bapna and Firat (2019)	Quickstart, Notebook
AdapterFusion	Pfeiffer et al. (2021)	Docs: Training, Notebook
MAD-X, Invertible adapters	Pfeiffer et al. (2020)	Notebook
AdapterDrop	Rücklé et al. (2021)	Notebook
MAD-X 2.0, Embedding training	Pfeiffer et al. (2021)	Docs: Embeddings, Notebook
Prefix Tuning	Li and Liang (2021)	Docs
Parallel adapters, Mix-and-Match adapters	He et al. (2021)	Docs
Compacter	Mahabadi et al. (2021)	Docs
LoRA	Hu et al. (2021)	Docs
(IA)^3	Liu et al. (2022)	Docs
UniPELT	Mao et al. (2022)	Docs

Supported Models

We currently support the PyTorch versions of all models listed on the Model Overview page in our documentation.

Citation

If you use this library for your work, please consider citing our paper AdapterHub: A Framework for Adapting Transformers:

@inproceedings{pfeiffer2020AdapterHub,
    title={AdapterHub: A Framework for Adapting Transformers},
    author={Pfeiffer, Jonas and
            R{\"u}ckl{\'e}, Andreas and
            Poth, Clifton and
            Kamath, Aishwarya and
            Vuli{\'c}, Ivan and
            Ruder, Sebastian and
            Cho, Kyunghyun and
            Gurevych, Iryna},
    booktitle={Proceedings of the 2020 Conference on Empirical Methods in Natural Language Processing: System Demonstrations},
    pages={46--54},
    year={2020}
}