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

PyPI Python Tests Install Test Coverage Docs License: AGPL v3

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.8.tar.gz (32.5 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.8-py3-none-any.whl (40.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scitex_decorators-0.1.8.tar.gz
  • Upload date:
  • Size: 32.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_decorators-0.1.8.tar.gz
Algorithm Hash digest
SHA256 3a46998a3679ad1cf9fa58f24f16fb155e0ca4c82efdbd1f9cb47987bca0b054
MD5 a613660689b99189d01f13a11184d18e
BLAKE2b-256 f6bea86565f566a89c124283ad3278435da13739bc62804e477e35b0c6fe6b5c

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_decorators-0.1.8.tar.gz:

Publisher: publish-pypi.yml on ywatanabe1989/scitex-decorators

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for scitex_decorators-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 84062c49ecc64c5480f4176cefa0b742f5938482f07cbd0bb1867e393900c444
MD5 b07f4a55113cc641af180a6011a9c60b
BLAKE2b-256 c73213cca2ac61b5a1030ec08dd40acc8f0da990db3c2145bf3446e737f3e079

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_decorators-0.1.8-py3-none-any.whl:

Publisher: publish-pypi.yml on ywatanabe1989/scitex-decorators

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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