joblib API reference
64 public APIs from joblib (joblib/joblib) — 31 classes, 8 functions, 25 methods. Signatures extracted by static analysis of the actual source.
Repository: joblib/joblib
| Kind | Count |
|---|---|
| Classes | 31 |
| Functions | 8 |
| Methods | 25 |
API list
class
joblib._dask.Batchdask-compatible wrapper that executes a batch of tasks
class
joblib._memmapping_reducer.ArrayMemmapForwardReducerReducer callable to dump large arrays to memmap files.
class
joblib._parallel_backends.AutoBatchingMixinA helper class for automagically batching jobs.
class
joblib._parallel_backends.FallbackToBackendRaised when configuration should fallback to another backend
method
joblib._parallel_backends.LokyBackend.submit(func, callback=None)Schedule a func to be run
class
joblib._parallel_backends.MultiprocessingBackendA ParallelBackend which will use a multiprocessing.Pool.
class
joblib._parallel_backends.PoolManagerMixinA helper class for managing pool of workers.
method
joblib._parallel_backends.PoolManagerMixin.submit(func, callback=None)Schedule a func to be run
method
joblib._parallel_backends.PoolManagerMixin.terminate()Shutdown the process or thread pool
method
joblib._parallel_backends.SequentialBackend.submit(func, callback=None)Schedule a func to be run
class
joblib._store_backends.CacheWarningWarning to capture dump failures except for PicklingError.
class
joblib._store_backends.FileSystemStoreBackendA StoreBackend used with local or network file systems.
method
joblib._store_backends.FileSystemStoreBackend.clear_location(location)Delete location on store.
class
joblib.compressor.BinaryGzipFileA file object providing transparent gzip (de)compression.
class
joblib.compressor.BinaryZlibFileA file object providing transparent zlib (de)compression.
method
joblib.compressor.BinaryZlibFile.close()Flush and close the file.
method
joblib.compressor.BinaryZlibFile.closed()True if this file is closed.
method
joblib.compressor.BinaryZlibFile.readinto(b)Read up to len(b) bytes into b.
method
joblib.compressor.BinaryZlibFile.seek(offset, whence=0)Change the file position.
method
joblib.compressor.BinaryZlibFile.tell()Return the current file position.
method
joblib.compressor.BinaryZlibFile.write(data)Write a byte string to the file.
class
joblib.compressor.CompressorWrapperA wrapper around a compressor file object.
func
joblib.compressor.register_compressor(compressor_name, compressor, force=False)Register a new compressor.
func
joblib.disk.disk_used(path)Return the disk usage in a directory.
func
joblib.disk.rm_subdirs(path, onerror=None)Remove all subdirectories in this path.
func
joblib.externals.loky.backend._posix_reduction.DupFd(fd)Return a wrapper for an fd.
class
joblib.externals.loky.backend.context.LokyContextContext relying on the LokyProcess.
method
joblib.externals.loky.backend.context.LokyContext.Condition(lock=None)Returns a condition object
method
joblib.externals.loky.backend.context.LokyContext.Event()Returns an event object
method
joblib.externals.loky.backend.context.LokyContext.Lock()Returns a lock object
method
joblib.externals.loky.backend.context.LokyContext.Queue(maxsize=0, reducers=None)Returns a queue object
method
joblib.externals.loky.backend.context.LokyContext.RLock()Returns a recurrent lock object
method
joblib.externals.loky.backend.context.LokyContext.Semaphore(value=1)Returns a semaphore object
method
joblib.externals.loky.backend.context.LokyContext.SimpleQueue(reducers=None)Returns a queue object
class
joblib.externals.loky.backend.popen_loky_win32.PopenStart a subprocess to run the code of a process object.
class
joblib.externals.loky.backend.resource_tracker.ResourceTrackerResource tracker with refcounting scheme.
func
joblib.externals.loky.backend.resource_tracker.main(fd, verbose=0)Run resource tracker.
class
joblib.hashing.NumpyHasherSpecial case the hasher for when numpy is loaded.
class
joblib.logger.LoggerBase class for logging messages.
method
joblib.logger.Logger.format(obj, indent=0)Return the formatted representation of the object.
class
joblib.logger.PrintTimePrint and log messages while keeping track of time.
class
joblib.memory.MemorizedResultObject representing a cached value.
method
joblib.memory.MemorizedResult.clear()Clear value from cache
method
joblib.memory.MemorizedResult.get()Read value from cache and return it.
method
joblib.memory.Memory.clear(warn=True)Erase the complete cache directory.
class
joblib.memory.NotMemorizedFuncNo-op object decorating a function.
class
joblib.memory.NotMemorizedResultClass representing an arbitrary value.
func
joblib.memory.register_store_backend(backend_name, backend)Extend available store backends.
class
joblib.numpy_pickle.NumpyArrayWrapperAn object to be persisted instead of numpy arrays.
method
joblib.numpy_pickle.NumpyArrayWrapper.read_mmap(unpickler)Read an array using numpy memmap.
class
joblib.numpy_pickle.NumpyPicklerA pickler to persist big data efficiently.
method
joblib.numpy_pickle.NumpyPickler.save(obj)Subclass the Pickler `save` method.
class
joblib.numpy_pickle.NumpyUnpicklerA subclass of the Unpickler to unpickle our numpy pickles.
class
joblib.numpy_pickle_compat.NDArrayWrapperAn object to be persisted instead of numpy arrays.
method
joblib.numpy_pickle_compat.NDArrayWrapper.read(unpickler)Reconstruct the array.
class
joblib.numpy_pickle_compat.ZNDArrayWrapperAn object to be persisted instead of numpy arrays.
class
joblib.numpy_pickle_compat.ZipNumpyUnpicklerA subclass of the Unpickler to unpickle our numpy pickles.
class
joblib.parallel.ParallelHelper class for readable parallel mapping.
func
joblib.parallel.cpu_count(only_physical_cores=False)Return the number of CPUs.
class
joblib.pool.CustomizablePicklerPickler that accepts custom reducers.
class
joblib.pool.CustomizablePicklingQueueLocked Pipe implementation that uses a customizable pickler.
class
joblib.pool.MemmappingPoolProcess pool that shares large arrays to avoid memory copy.
class
joblib.pool.PicklingPoolPool implementation with customizable pickling reducers.
func
joblib.testing.warnings_to_stdout()Redirect all warnings to stdout.
About this data
These signatures were extracted from the public source of joblib/joblib
using Python's ast module. Argument names, default values,
type annotations and return types are taken verbatim from the code.
Implementation bodies are never stored. See
how it works for details.