joblib

Die Homepage von joblib mit Benutzerdokumentation finden Sie unter:

https://joblib.readthedocs.io

Holen Sie sich den neuesten Code

Um den neuesten Code mit Git zu erhalten, geben Sie einfach Folgendes ein:

 Git-Klon https://github.com/joblib/joblib.git

Wenn Sie Git nicht installiert haben, können Sie eine Zip-Datei des neuesten Codes herunterladen: https://github.com/joblib/joblib/archive/refs/heads/main.zip

Installieren

Sie können pip verwenden, um joblib zu installieren:

 pip install joblib

aus einem beliebigen Verzeichnis oder:

 Python setup.py installieren

aus dem Quellverzeichnis.

Abhängigkeiten

• Joblib hat außer Python keine obligatorischen Abhängigkeiten (unterstützte Versionen sind 3.8+).
• Joblib verfügt für die Array-Manipulation über eine optionale Abhängigkeit von Numpy (mindestens Version 1.6.1).
• Joblib enthält eine eigene Kopie von Loky für das Prozessmanagement.
• Joblib kann Numpy-Arrays effizient sichern und laden, erfordert jedoch keine Installation von Numpy.
• Joblib verfügt über eine optionale Abhängigkeit von python-lz4 als schnellere Alternative zu zlib und gzip für die komprimierte Serialisierung.
• Joblib verfügt über eine optionale Abhängigkeit von psutil, um Speicherlecks in parallelen Arbeitsprozessen zu verringern.
• Einige Beispiele erfordern externe Abhängigkeiten wie Pandas. Weitere Informationen finden Sie in den Anweisungen im Abschnitt „Dokumente erstellen“.

Workflow zum Mitwirken

Um zu joblib beizutragen, erstellen Sie zunächst ein Konto auf Github. Sobald dies erledigt ist, forken Sie das Joblib-Repository, um Ihr eigenes Repository zu haben, und klonen Sie es mit „git clone“ auf den Computern, auf denen Sie arbeiten möchten. Nehmen Sie Ihre Änderungen in Ihrem Klon vor, übertragen Sie sie per Push auf Ihr Github-Konto, testen Sie sie auf mehreren Computern und senden Sie, wenn Sie damit zufrieden sind, eine Pull-Anfrage an das Haupt-Repository.

Ausführen der Testsuite

Um die Testsuite auszuführen, benötigen Sie die Module pytest (Version >= 3) und Coverage. Führen Sie die Testsuite aus mit:

 pytest joblib

aus dem Stammverzeichnis des Projekts.

Erstellen der Dokumente

Um die Dokumente zu erstellen, müssen Sphinx (>=1.4) und einige Abhängigkeiten installiert sein:

 pip install -U -r .readthedocs-requirements.txt

Die Dokumente können dann mit dem folgenden Befehl erstellt werden:

 Dok. machen

Die HTML-Dokumente befinden sich im Verzeichnis doc/_build/html .

Erstellen eines Quell-Tarballs

Um einen Quell-Tarball zu erstellen, z. B. zum Verpacken oder Verteilen, führen Sie den folgenden Befehl aus:

 python setup.py sdist

Der Tarball wird im dist-Verzeichnis erstellt. Dieser Befehl kompiliert die Dokumente und der resultierende Tarball kann ohne zusätzliche Abhängigkeiten als die Python-Standardbibliothek installiert werden. Sie benötigen Setuptool und Sphinx.

Eine Veröffentlichung erstellen und auf PyPI hochladen

Dieser Befehl wird nur vom Projektmanager ausgeführt, um eine Veröffentlichung zu erstellen und in PyPI hochzuladen:

 python setup.py sdist bdist_wheel
Schnur-Upload dist/*

Beachten Sie, dass die Dokumentation bei jedem Git-Push automatisch aktualisiert werden sollte. Wenn dies nicht der Fall ist, versuchen Sie, das Dokument lokal zu erstellen und etwaige Dokumenterstellungsfehler zu beheben (insbesondere beim Ausführen der Beispiele).

Aktualisierung des Änderungsprotokolls

Änderungen werden in der Datei CHANGES.rst aufgeführt. Sie müssen manuell aktualisiert werden, aber der folgende Git-Befehl kann zum Generieren der Zeilen verwendet werden:

 git log --abbrev-commit --date=short --no-merges --sparse