Skip to main content

Decorator library: numpy_fn/torch_fn/pandas_fn/xarray_fn/signal_fn type converters, caching, batching, deprecation — standalone module from the SciTeX ecosystem

Project description

scitex-decorators

Decorator library extracted from the SciTeX ecosystem as a standalone package.

Install

pip install scitex-decorators              # core (numpy only)
pip install "scitex-decorators[caching]"   # + joblib for cache_disk
pip install "scitex-decorators[torch]"     # + torch_fn / batch_torch_fn
pip install "scitex-decorators[all]"       # everything

API

import scitex_decorators as dec

# Type-conversion decorators (cast args before calling, restore after)
@dec.numpy_fn  ; @dec.torch_fn  ; @dec.pandas_fn  ; @dec.xarray_fn
@dec.signal_fn

# Caching (joblib for disk, dict for mem)
@dec.cache_disk        ; @dec.cache_disk_async    ; @dec.cache_mem

# Batching
@dec.batch_fn          ; @dec.batch_numpy_fn / batch_torch_fn / batch_pandas_fn

# Misc
@dec.deprecated(reason="…")
@dec.not_implemented
@dec.preserve_doc
@dec.timeout(seconds=10)
@dec.wrap

# Auto-ordering machinery (advanced)
dec.enable_auto_order() ; dec.disable_auto_order()

# Conversion helpers
dec.to_numpy(x) ; dec.to_torch(x)
dec.is_torch(x) ; dec.is_cuda(x) ; dec.is_nested_decorator(...)

Cache directory resolution

cache_disk / cache_disk_async resolve the cache dir in this order:

  1. scitex.config.get_paths().function_cache (only if scitex is installed)
  2. ${SCITEX_CACHE_DIR}/function_cache
  3. ${XDG_CACHE_HOME}/scitex-decorators/function_cache
  4. ~/.cache/scitex-decorators/function_cache

So the package works without the umbrella scitex installed.

Status

Standalone fork of scitex.decorators. Zero scitex.* runtime deps. The umbrella package's scitex.decorators import path is preserved via a sys.modules-alias bridge.

License

AGPL-3.0-only (see LICENSE).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scitex_decorators-0.1.1.tar.gz (28.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scitex_decorators-0.1.1-py3-none-any.whl (36.3 kB view details)

Uploaded Python 3

File details

Details for the file scitex_decorators-0.1.1.tar.gz.

File metadata

  • Download URL: scitex_decorators-0.1.1.tar.gz
  • Upload date:
  • Size: 28.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for scitex_decorators-0.1.1.tar.gz
Algorithm Hash digest
SHA256 eae4cc459244c89edd1a32ed227d56ceb68f15967f5cda8c4362f2a220cdfd96
MD5 5372cd4f36d9fcd9080e22b403fcde0d
BLAKE2b-256 7e378f82f9ff294aa8a897afcb954e1c81361147f6e98b50705ea130c454cde8

See more details on using hashes here.

File details

Details for the file scitex_decorators-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for scitex_decorators-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 659d00251eceb5bb80ea853ffe952faa936fb9bd6984554bfb7104e9ca685385
MD5 fe4d022449e9d0f4234d94cd0efb298e
BLAKE2b-256 1d9452ec45084f549fdee93fe760b84ddffec5f92b8e20a2ff2eab458193cc39

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page