https://github.com/joblib/joblib

Computing with Python functions.
https://github.com/joblib/joblib

caching memoization multiprocessing parallel-computing python threading

Last synced: about 8 hours ago
JSON representation

Computing with Python functions.

• Host: GitHub
• URL: https://github.com/joblib/joblib
• Owner: joblib
• License: bsd-3-clause
• Created: 2010-05-07T06:48:26.000Z (almost 15 years ago)
• Default Branch: main
• Last Pushed: 2025-04-11T11:34:54.000Z (12 days ago)
• Last Synced: 2025-04-22T09:51:03.279Z (about 15 hours ago)
• Topics: caching, memoization, multiprocessing, parallel-computing, python, threading
• Language: Python
• Homepage: http://joblib.readthedocs.org
• Size: 4.21 MB
• Stars: 4,043
• Watchers: 62
• Forks: 429
• Open Issues: 421
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.txt
  • Citation: CITATION.cff
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-systematic-trading - Joblib - commit/joblib/joblib/main)  | Python | - running Python functions as pipeline jobs (Basic Components / Computation)
• awesome-meteo - joblib
• awesome-list - Joblib - Running Python functions as pipeline jobs, with optimizations for numpy. (Linear Algebra / Statistics Toolkit / General Purpose Tensor Library)
• awesome-imbalanced-learning - joblib
• starred-awesome - joblib - Python function as pipeline jobs. (Python)
• awesome-python-machine-learning-resources - GitHub - 43% open · ⏱️ 20.05.2022): (数据管道和流处理)
• best-of-python - GitHub - 45% open · ⏱️ 02.05.2024): (Data Pipelines & Streaming)

README

        
|PyPi| |CIStatus| |ReadTheDocs| |Codecov|

.. |PyPi| image:: https://badge.fury.io/py/joblib.svg

   :target: https://badge.fury.io/py/joblib

   :alt: Joblib version

.. |CIStatus| image:: https://github.com/joblib/joblib/actions/workflows/test.yml/badge.svg

   :target: https://github.com/joblib/joblib/actions/workflows/test.yml?query=branch%3Amain

   :alt: CI status

.. |ReadTheDocs| image:: https://readthedocs.org/projects/joblib/badge/?version=latest

    :target: https://joblib.readthedocs.io/en/latest/?badge=latest

    :alt: Documentation Status

.. |Codecov| image:: https://codecov.io/gh/joblib/joblib/branch/main/graph/badge.svg

   :target: https://codecov.io/gh/joblib/joblib

   :alt: Codecov coverage

The homepage of joblib with user documentation is located on:

https://joblib.readthedocs.io

Getting the latest code

=======================

To get the latest code using git, simply type::

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

If you don't have git installed, you can download a zip

of the latest code: https://github.com/joblib/joblib/archive/refs/heads/main.zip

Installing

==========

You can use `pip` to install joblib from any directory::

    pip install joblib

or install it in editable mode from the source directory::

    pip install -e .

Dependencies

============

- Joblib has no mandatory dependencies besides Python (supported versions are

  3.9+).

- Joblib has an optional dependency on Numpy (at least version 1.6.1) for array

  manipulation.

- Joblib includes its own vendored copy of

  `loky `_ for process management.

- Joblib can efficiently dump and load numpy arrays but does not require numpy

  to be installed.

- Joblib has an optional dependency on

  `python-lz4 `_ as a faster alternative to

  zlib and gzip for compressed serialization.

- Joblib has an optional dependency on psutil to mitigate memory leaks in

  parallel worker processes.

- Some examples require external dependencies such as pandas. See the

  instructions in the `Building the docs`_ section for details.

Workflow to contribute

======================

To contribute to joblib, first create an account on `github

`_. Once this is done, fork the `joblib repository

`_ to have your own repository,

clone it using ``git clone``. Make your changes in a branch of your clone, push

them to your github account, test them locally, and when you are happy with

them, send a pull request to the main repository.

You can use `pre-commit `_ to run code style checks

before each commit::

    pip install pre-commit

    pre-commit install

pre-commit checks can be disabled for a single commit with::

    git commit -n

Running the test suite

======================

To run the test suite, you need the pytest (version >= 3) and coverage modules.

Run the test suite using::

    pytest joblib

from the root of the project.

Building the docs

=================

To build the docs you need to have sphinx (>=1.4) and some dependencies

installed::

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

The docs can then be built with the following command::

    make doc

The html docs are located in the ``doc/_build/html`` directory.

Making a source tarball

=======================

To create a source tarball, eg for packaging or distributing, run the

following command::

    pip install build

    python -m build --sdist

The tarball will be created in the `dist` directory. This command will create

the resulting tarball that can be installed with no extra dependencies than the

Python standard library.

Making a release and uploading it to PyPI

=========================================

This command is only run by project manager, to make a release, and

upload in to PyPI::

    pip install build

    python -m build --sdist --wheel

    twine upload dist/*

Note that the documentation should automatically get updated at each git

push. If that is not the case, try building th doc locally and resolve

any doc build error (in particular when running the examples).

Updating the changelog

======================

Changes are listed in the CHANGES.rst file. They must be manually updated

but, the following git command may be used to generate the lines::

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