joblib

La page d'accueil de joblib avec la documentation utilisateur se trouve sur :

https://joblib.readthedocs.io

Obtenir le dernier code

Pour obtenir le dernier code en utilisant git, tapez simplement :

 clone git https://github.com/joblib/joblib.git

Si git n'est pas installé, vous pouvez télécharger un zip du dernier code : https://github.com/joblib/joblib/archive/refs/heads/main.zip

Installation

Vous pouvez utiliser pip pour installer joblib :

 pip installer joblib

depuis n'importe quel répertoire ou :

 installation de python setup.py

à partir du répertoire source.

Dépendances

• Joblib n'a pas de dépendances obligatoires en dehors de Python (les versions prises en charge sont 3.8+).
• Joblib a une dépendance facultative sur Numpy (au moins la version 1.6.1) pour la manipulation des tableaux.
• Joblib inclut sa propre copie vendue de loky pour la gestion des processus.
• Joblib peut vider et charger efficacement des tableaux numpy mais ne nécessite pas l'installation de numpy.
• Joblib a une dépendance facultative sur python-lz4 comme alternative plus rapide à zlib et gzip pour la sérialisation compressée.
• Joblib a une dépendance facultative sur psutil pour atténuer les fuites de mémoire dans les processus de travail parallèles.
• Certains exemples nécessitent des dépendances externes telles que les pandas. Consultez les instructions dans la section Création de la documentation pour plus de détails.

Flux de travail pour contribuer

Pour contribuer à joblib, créez d'abord un compte sur github. Une fois cela fait, forkez le référentiel joblib pour avoir votre propre référentiel, clonez-le en utilisant 'git clone' sur les ordinateurs sur lesquels vous souhaitez travailler. Apportez vos modifications dans votre clone, transférez-les sur votre compte github, testez-les sur plusieurs ordinateurs et lorsque vous en êtes satisfait, envoyez une pull request au référentiel principal.

Exécuter la suite de tests

Pour exécuter la suite de tests, vous avez besoin du pytest (version >= 3) et des modules de couverture. Exécutez la suite de tests en utilisant :

 pytest joblib

à partir de la racine du projet.

Construire les documents

Pour créer la documentation, vous devez avoir installé sphinx (>=1.4) et certaines dépendances :

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

Les documents peuvent ensuite être construits avec la commande suivante :

 faire un document

Les documents HTML se trouvent dans le répertoire doc/_build/html .

Créer une archive tar source

Pour créer une archive tar source, par exemple pour l'empaquetage ou la distribution, exécutez la commande suivante :

 python setup.py sdist

L'archive tar sera créée dans le répertoire dist. Cette commande compilera la documentation et l'archive tar résultante pourra être installée sans dépendances supplémentaires par rapport à la bibliothèque standard Python. Vous aurez besoin de setuptool et de sphinx.

Créer une version et la télécharger sur PyPI

Cette commande est exécutée uniquement par le chef de projet, pour créer une version et la télécharger sur PyPI :

 python setup.py sdist bdist_wheel
distribution de téléchargement de ficelle/*

Notez que la documentation doit être automatiquement mise à jour à chaque git push. Si ce n'est pas le cas, essayez de construire la doc localement et résolvez toute erreur de construction de la doc (en particulier lors de l'exécution des exemples).

Mise à jour du journal des modifications

Les modifications sont répertoriées dans le fichier CHANGES.rst. Ils doivent être mis à jour manuellement mais la commande git suivante peut être utilisée pour générer les lignes :

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