fairseq2
v0.2.0
Dokumentation: Stabil, Nächtlich | Installieren: Linux, macOS, Windows, Von der Quelle | Mitwirken: Richtlinien
fairseq2 ist ein Sequenzmodellierungs-Toolkit, mit dem Forscher und Entwickler benutzerdefinierte Modelle für Übersetzung, Zusammenfassung, Sprachmodellierung und andere Aufgaben zur Inhaltsgenerierung trainieren können. Es ist auch der Nachfolger von fairseq.
Besuchen Sie unsere Dokumentationswebsite.
Aktuelle Änderungen finden Sie in unserem Änderungsprotokoll.
Ab heute sind folgende Modelle in fairseq2 verfügbar:
fairseq2 wird auch von verschiedenen externen Projekten verwendet, wie zum Beispiel:
fairseq2 hängt von libsndfile ab, das auf den meisten Linux-Distributionen über den Systempaketmanager installiert werden kann. Führen Sie für Ubuntu-basierte Systeme Folgendes aus:
sudo apt install libsndfile1Führen Sie auf Fedora auf ähnliche Weise Folgendes aus:
sudo dnf install libsndfileFür andere Linux-Distributionen lesen Sie bitte deren Dokumentation zur Installation von Paketen.
Führen Sie Folgendes aus, um fairseq2 unter Linux x86-64 zu installieren:
pip install fairseq2Dieser Befehl installiert eine Version von fairseq2, die mit PyTorch kompatibel ist, das auf PyPI gehostet wird.
Derzeit bieten wir kein vorgefertigtes Paket für ARM-basierte Systeme wie Raspberry PI oder NVIDIA Jetson an. Weitere Informationen zum Erstellen und Installieren von fairseq2 auf diesen Systemen finden Sie unter Von der Quelle installieren.
Neben PyPI bietet fairseq2 auch vorgefertigte Pakete für verschiedene PyTorch- und CUDA-Versionen, die im Paket-Repository von FAIR gehostet werden. Die folgende Matrix zeigt die unterstützten Kombinationen.
| fairseq2 | PyTorch | Python | Variante* | Bogen |
|---|---|---|---|---|
HEAD | 2.5.0 , 2.5.1 | >=3.10 , <=3.12 | cpu , cu118 , cu121 , cu124 | x86_64 |
2.4.0 , 2.4.1 | >=3.10 , <=3.12 | cpu , cu118 , cu121 , cu124 | x86_64 | |
2.3.0 , 2.3.1 | >=3.10 , <=3.12 | cpu , cu118 , cu121 | x86_64 | |
0.3.0 | 2.5.0 , 2.5.1 | >=3.10 , <=3.12 | cpu , cu118 , cu121 , cu124 | x86_64 |
2.4.0 , 2.4.1 | >=3.10 , <=3.12 | cpu , cu118 , cu121 , cu124 | x86_64 | |
2.3.0 , 2.3.1 | >=3.10 , <=3.12 | cpu , cu118 , cu121 | x86_64 | |
0.2.0 | 2.1.1 | >=3.8 , <=3.11 | cpu , cu118 , cu121 | x86_64 |
2.0.1 | >=3.8 , <=3.11 | cpu , cu117 , cu118 | x86_64 | |
1.13.1 | >=3.8 , <=3.10 | cpu , cu116 | x86_64 |
* cuXYZ bezieht sich auf CUDA XY.Z (z. B. cu118 bedeutet CUDA 11.8)
Um eine bestimmte Kombination zu installieren, folgen Sie zunächst den Installationsanweisungen auf pytorch.org für die gewünschte PyTorch-Version und verwenden Sie dann den folgenden Befehl (gezeigt für PyTorch 2.5.1 und Variante cu124 ):
pip install fairseq2
--extra-index-url https://fair.pkg.atmeta.com/fairseq2/whl/pt2.5.1/cu124Warnung
fairseq2 basiert auf der C++-API von PyTorch, die keine API/ABI-Kompatibilität zwischen Versionen aufweist. Das bedeutet, dass Sie die fairseq2-Variante installieren müssen, die genau zu Ihrer PyTorch-Version passt . Andernfalls kann es zu Problemen wie sofortigen Prozessabstürzen oder falschen Segfaults kommen. Aus dem gleichen Grund müssen Sie, wenn Sie Ihre PyTorch-Version aktualisieren, auch Ihre fairseq2-Installation aktualisieren.
Für Linux hosten wir auch nächtliche Builds im Paket-Repository von FAIR. Die unterstützten Varianten sind identisch mit den oben unter Varianten aufgeführten. Sobald Sie die gewünschte PyTorch-Version installiert haben, können Sie mit dem folgenden Befehl das entsprechende Nightly-Paket installieren (gezeigt für PyTorch 2.5.1 und Variante cu124 ):
pip install fairseq2
--pre --extra-index-url https://fair.pkg.atmeta.com/fairseq2/whl/nightly/pt2.5.1/cu124fairseq2 hängt von libsndfile ab, das über Homebrew installiert werden kann:
brew install libsndfileUm fairseq2 auf ARM64-basierten (d. h. Apple-Silizium-)Mac-Computern zu installieren, führen Sie Folgendes aus:
pip install fairseq2Dieser Befehl installiert eine Version von fairseq2, die mit PyTorch kompatibel ist, das auf PyPI gehostet wird.
Derzeit bieten wir kein vorgefertigtes Paket für Intel-basierte Mac-Computer an. Weitere Informationen zum Erstellen und Installieren von fairseq2 auf Intel-Computern finden Sie unter Von der Quelle installieren.
Neben PyPI bietet fairseq2 auch vorgefertigte Pakete für verschiedene PyTorch-Versionen, die im Paket-Repository von FAIR gehostet werden. Die folgende Matrix zeigt die unterstützten Kombinationen.
| fairseq2 | PyTorch | Python | Bogen |
|---|---|---|---|
0.3.0 | 2.5.1 | >=3.10 , <=3.12 | arm64 |
Um eine bestimmte Kombination zu installieren, befolgen Sie zunächst die Installationsanweisungen auf pytorch.org für die gewünschte PyTorch-Version und verwenden Sie dann den folgenden Befehl (angezeigt für PyTorch 2.5.1 ):
pip install fairseq2
--extra-index-url https://fair.pkg.atmeta.com/fairseq2/whl/pt2.5.1/cpuWarnung
fairseq2 basiert auf der C++-API von PyTorch, die keine API/ABI-Kompatibilität zwischen Versionen aufweist. Das bedeutet, dass Sie die fairseq2-Variante installieren müssen, die genau zu Ihrer PyTorch-Version passt . Andernfalls kann es zu Problemen wie sofortigen Prozessabstürzen oder falschen Segfaults kommen. Aus dem gleichen Grund müssen Sie, wenn Sie Ihre PyTorch-Version aktualisieren, auch Ihre fairseq2-Installation aktualisieren.
Für macOS hosten wir auch nächtliche Builds im Paket-Repository von FAIR. Die unterstützten Varianten sind identisch mit den oben unter Varianten aufgeführten. Sobald Sie die gewünschte PyTorch-Version installiert haben, können Sie mit dem folgenden Befehl das entsprechende Nightly-Paket installieren (gezeigt für PyTorch 2.5.1 ):
pip install fairseq2
--pre --extra-index-url https://fair.pkg.atmeta.com/fairseq2/whl/nightly/pt2.5.1/cpufairseq2 bietet keine native Unterstützung für Windows und es gibt keine Pläne, dies in absehbarer Zukunft zu unterstützen. Sie können fairseq2 jedoch über das Windows-Subsystem für Linux (auch WSL genannt) zusammen mit der in WSL 2 eingeführten vollständigen CUDA-Unterstützung verwenden. Bitte befolgen Sie die Anweisungen im Abschnitt „Installation unter Linux“ für eine WSL-basierte Installation.
Siehe hier.
Wir freuen uns immer über Beiträge zu fairseq2! Bitte beachten Sie die Beitragsrichtlinien, um zu erfahren, wie Sie Ihre Arbeit formatieren, testen und einreichen.
Wenn Sie fairseq2 in Ihrer Recherche verwenden und darauf verweisen möchten, verwenden Sie bitte den folgenden BibTeX-Eintrag.
@software{balioglu2023fairseq2,
author = {Can Balioglu},
title = {fairseq2},
url = {http://github.com/facebookresearch/fairseq2},
year = {2023},
}
Dieses Projekt ist MIT-lizenziert, wie in der LICENSE-Datei zu finden.
