joblib

La página de inicio de joblib con documentación del usuario se encuentra en:

https://joblib.readthedocs.io

Obteniendo el código más reciente

Para obtener el código más reciente usando git, simplemente escriba:

 clon de git https://github.com/joblib/joblib.git

Si no tiene git instalado, puede descargar un zip del código más reciente: https://github.com/joblib/joblib/archive/refs/heads/main.zip

Instalación

Puedes usar pip para instalar joblib:

 pip instalar joblib

desde cualquier directorio o:

 instalación de python setup.py

desde el directorio fuente.

Dependencias

• Joblib no tiene dependencias obligatorias además de Python (las versiones compatibles son 3.8+).
• Joblib tiene una dependencia opcional de Numpy (al menos la versión 1.6.1) para la manipulación de matrices.
• Joblib incluye su propia copia de loky para la gestión de procesos.
• Joblib puede volcar y cargar matrices numpy de manera eficiente, pero no requiere la instalación de numpy.
• Joblib tiene una dependencia opcional de python-lz4 como una alternativa más rápida a zlib y gzip para la serialización comprimida.
• Joblib tiene una dependencia opcional de psutil para mitigar las pérdidas de memoria en procesos de trabajo paralelos.
• Algunos ejemplos requieren dependencias externas como pandas. Consulte las instrucciones en la sección Creación de documentos para obtener más detalles.

Flujo de trabajo para contribuir

Para contribuir a joblib, primero cree una cuenta en github. Una vez hecho esto, bifurca el repositorio joblib para tener tu propio repositorio, clónalo usando 'git clone' en las computadoras donde quieras trabajar. Realice sus cambios en su clon, envíelos a su cuenta de github, pruébelos en varias computadoras y, cuando esté satisfecho con ellos, envíe una solicitud de extracción al repositorio principal.

Ejecutando el conjunto de pruebas

Para ejecutar el conjunto de pruebas, necesita los módulos pytest (versión >= 3) y de cobertura. Ejecute el conjunto de pruebas usando:

 biblioteca de trabajo pytest

desde la raíz del proyecto.

Construyendo los documentos

Para compilar los documentos necesitas tener sphinx (>=1.4) y algunas dependencias instaladas:

 instalación de pip -U -r .readthedocs-requirements.txt

Luego, los documentos se pueden compilar con el siguiente comando:

 hacer doc

Los documentos html se encuentran en el directorio doc/_build/html .

Hacer un tarball fuente

Para crear un archivo tar de origen, por ejemplo, para empaquetar o distribuir, ejecute el siguiente comando:

 python setup.py sdist

El tarball se creará en el directorio dist. Este comando compilará los documentos y el tarball resultante se podrá instalar sin dependencias adicionales a las de la biblioteca estándar de Python. Necesitará setuptool y sphinx.

Hacer un lanzamiento y subirlo a PyPI

Este comando solo lo ejecuta el administrador del proyecto para realizar un lanzamiento y cargarlo en PyPI:

 python setup.py sdist bdist_wheel
cordel subir dist/*

Tenga en cuenta que la documentación debería actualizarse automáticamente en cada git push. Si ese no es el caso, intente compilar el documento localmente y resuelva cualquier error de compilación del documento (en particular al ejecutar los ejemplos).

Actualizando el registro de cambios

Los cambios se enumeran en el archivo CHANGES.rst. Deben actualizarse manualmente, pero se puede usar el siguiente comando git para generar las líneas:

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