Installation

Before you start, you will need to setup your environment, install the appropriate packages, and configure 🤗 PEFT. 🤗 PEFT is tested on Python 3.9+.

🤗 PEFT is available on PyPI, as well as GitHub:

PyPI

To install 🤗 PEFT from PyPI:

pip install peft

NVIDIA Spark (ARM64)

To install PEFT with PyTorch on NVIDIA Spark devices (such as an RTX Spark laptop) running ARM64, install PyTorch from the NVIDIA PyPI index. These devices require NVIDIA’s ARM64 builds of PyTorch, which are not available on the default PyPI index or the standard PyTorch wheel index.

Run the command below to check if your system detects an NVIDIA GPU.

nvidia-smi

Install PyTorch from the NVIDIA PyPI index, then install PEFT.

pip install torch --index-url https://pypi.nvidia.com
pip install peft

Source

New features that haven’t been released yet are added every day, which also means there may be some bugs. To try them out, install from the GitHub repository:

pip install git+https://github.com/huggingface/peft

If you wish to play with the source code and see live results as you run the code, an editable version can be installed from a locally-cloned version of the repository:

git clone https://github.com/huggingface/peft
cd peft
pip install -e ".[test]"

If you’re planning to contribute to PEFT, follow the contributing guide instead, which also covers forking, adding the upstream remote, and creating a working branch.