Joblibs3

|CI| |Codecov|

.. |CI| image:: https://github.com/aabadie/joblib-s3/workflows/CI/badge.svg :target: https://github.com/aabadie/joblib-s3/actions?query=workflow%3ACI+branch%3Amain

.. |Codecov| image:: https://codecov.io/gh/aabadie/joblib-s3/branch/master/graph/badge.svg :target: https://codecov.io/gh/aabadie/joblib-s3

This package provides an AWS store backend for the joblib Memory object used for fast caching of computation results.

Initially, only local (or network shares) file systems were supported with joblib but now joblib offers the possibility to register extra store backends matching the provided StoreBackendBase API.

If you don't know joblib already, user documentation is located on https://pythonhosted.org/joblib

If you are only interested in computation result caching in joblib, the Memory documentation is available here <https://pythonhosted.org/joblib/memory.html>_.

The AWS S3 backend relies on the dask s3fs <https://s3fs.readthedocs.io/en/latest/index.html>_ package.

Joblibs3 supports Python 2.7, 3.4 and 3.5.

Getting the latest code

To get the latest code use git::

git clone git://github.com/aabadie/joblib-s3.git

Installing joblibs3

Simply use pip:

.. code-block:: bash

$ cd joblib-s3
$ pip install -r requirements.txt .

Using joblibs3 to cache computation results in AWS S3

See the following example:

.. code-block:: python

# Import the required packages
import numpy as np
from joblib import Memory
from joblibs3 import register_s3fs_store_backend
# Optionally, instantiate a session to use AWS_PROFILE from ~/.aws/config
# from aiobotocore.session import AioSession

if __name__ == '__main__':
    register_s3fs_store_backend()

    # we assume you S3 credentials are stored in ~/.aws/credentials, so no
    # need to pass them to Memory constructor.
    backend_options = dict(
        bucket='joblib-example',
        # Optional
        #session=AioSession(profile='my-profile'),
    )
    mem = Memory('joblib_cache', backend='s3', verbose=100, compress=True,
                 backend_options=backend_options)

    multiply = mem.cache(np.multiply)
    array1 = np.arange(10000)
    array2 = np.arange(10000)

    result = multiply(array1, array2)
    print(result)

This example is available in the examples <examples>_ directory.

Developping

Tests can be run using Tox <https://tox.wiki>. pre-commit <https://pre-commit.com/> is used to perform usual sanity checks (black, isort, ruff, etc).