Accelerate documentation

Installation

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v1.15.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Installation

Avant de commencer, vous devez configurer votre environnement, installer les paquets appropriés et configurer Accelerate. Accelerate est testé sur Python 3.11+.

Accelerate est disponible sur pypi et conda, ainsi que sur GitHub. Les détails pour l’installer depuis chacune de ces sources sont ci-dessous :

pip

Pour installer Accelerate depuis pypi, exécutez :

pip install accelerate

conda

Accelerate peut également être installé avec conda à l'aide de :

conda install -c conda-forge accelerate

Source

De nouvelles fonctionnalités sont ajoutées chaque jour et n’ont pas encore été publiées. Pour les essayer vous-même, installez à partir du dépôt GitHub :

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

Si vous souhaitez contribuer à la bibliothèque ou expérimenter avec le code source et voir les résultats en direct à mesure que vous exécutez le code, une version modifiable peut être installée à partir d’une version clonée localement du dépôt :

git clone https://github.com/huggingface/accelerate
cd accelerate
pip install -e .

Configuration

Après l’installation, vous devez configurer Accelerate en fonction de la configuration du système actuel pour l’entraînement. Pour ce faire, exécutez la commande suivante et répondez aux questions qui vous sont posées :

accelerate config

Pour écrire une configuration minimale qui n’inclut pas d’options telles que la configuration DeepSpeed ou l’exécution sur des TPU, vous pouvez rapidement exécuter :

python -c "from accelerate.utils import write_basic_config; write_basic_config(mixed_precision='fp16')"

Accelerate utilisera automatiquement le nombre maximal de GPU disponibles et définira le mode de précision mixte.

Pour vérifier que votre configuration est correcte, exécutez :

accelerate env

Un exemple de sortie est présenté ci-dessous, décrivant deux GPU sur une seule machine, sans utilisation de la précision mixte :

- `Accelerate` version: 1.2.0.dev0
- Platform: Linux-6.8.0-47-generic-x86_64-with-glibc2.35
- `accelerate` bash location: /home/zach/miniconda3/envs/accelerate/bin/accelerate
- Python version: 3.10.13
- Numpy version: 1.26.4
- PyTorch version (GPU?): 2.5.1+cu124 (True)
- PyTorch XPU available: False
- PyTorch NPU available: False
- PyTorch MLU available: False
- PyTorch MUSA available: False
- System RAM: 187.91 GB
- GPU type: NVIDIA GeForce RTX 4090
- `Accelerate` default config:
        - compute_environment: LOCAL_MACHINE
        - distributed_type: MULTI_GPU
        - mixed_precision: no
        - use_cpu: False
        - debug: False
        - num_processes: 2
        - machine_rank: 0
        - num_machines: 1
        - gpu_ids: all
        - rdzv_backend: static
        - same_network: True
        - main_training_function: main
        - enable_cpu_affinity: False
        - downcast_bf16: no
        - tpu_use_cluster: False
        - tpu_use_sudo: False
        - tpu_env: []
Update on GitHub