The homepage of joblib with user documentation is located on:
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 supports Python >= 3.10.
The only dependency is cloudpickle >= 3.
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. The oldest numpy version supported is the oldest numpy version supported by Python 3.10 (numpy version 1.21.3).
Joblib can use Dask distributed backend but does not require distributed to be installed. The oldest distributed version supported is 2022.8.1.
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:
pip install joblib[test] 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 .[docs]
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
To generate a release, create a new Release in GitHub; the release will be automatically published to PyPI.
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
4 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file joblib-1.6.0.tar.gz.
File metadata
- Download URL: joblib-1.6.0.tar.gz
- Upload date:
- Size: 327.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2ccc96785b12046c08fd6d55839c12857831b54a3c1673ffadd2f04bfc4eda03
|
|
| MD5 |
9c4ac71a0de48c7eaedafb0436ef6677
|
|
| BLAKE2b-256 |
d51d537ab090f302b838943a1b56497dd53059b9a9b46a074936470173a2e207
|
Provenance
The following attestation bundles were made for joblib-1.6.0.tar.gz:
Publisher:
publish-to-pypi.yml on joblib/joblib
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
joblib-1.6.0.tar.gz -
Subject digest:
2ccc96785b12046c08fd6d55839c12857831b54a3c1673ffadd2f04bfc4eda03 - Sigstore transparency entry: 2661585049
- Sigstore integration time:
-
Permalink:
joblib/joblib@cd9a6b05fc4f2b1c8202eb62c4e863484f8cc099 -
Branch / Tag:
refs/tags/1.6.0 - Owner: https://github.com/joblib
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@cd9a6b05fc4f2b1c8202eb62c4e863484f8cc099 -
Trigger Event:
push
-
Statement type:
File details
Details for the file joblib-1.6.0-py3-none-any.whl.
File metadata
- Download URL: joblib-1.6.0-py3-none-any.whl
- Upload date:
- Size: 306.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3dbbf9f6e4b592a2357b854608e980fe6390d131d7a82f011a377ef2ebef7aba
|
|
| MD5 |
2168676ac58273dcc3cb366e9e7cee2e
|
|
| BLAKE2b-256 |
185384099323c2ec4be98d935f63c033ac4151ee83836ca1050ede3b3aadf155
|
Provenance
The following attestation bundles were made for joblib-1.6.0-py3-none-any.whl:
Publisher:
publish-to-pypi.yml on joblib/joblib
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
joblib-1.6.0-py3-none-any.whl -
Subject digest:
3dbbf9f6e4b592a2357b854608e980fe6390d131d7a82f011a377ef2ebef7aba - Sigstore transparency entry: 2661585141
- Sigstore integration time:
-
Permalink:
joblib/joblib@cd9a6b05fc4f2b1c8202eb62c4e863484f8cc099 -
Branch / Tag:
refs/tags/1.6.0 - Owner: https://github.com/joblib
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@cd9a6b05fc4f2b1c8202eb62c4e863484f8cc099 -
Trigger Event:
push
-
Statement type:
