Skip to main content

Running/online statistics for PyTorch

Project description

pytorch_runstats

Running/online statistics for PyTorch.

Documentation Status

torch_runstats implements memory-efficient online reductions on tensors.

Notable features:

  • Arbitrary sample shapes beyond single scalars
  • Reduction over arbitrary dimensions of each sample
  • "Batched"/"binned" reduction into multiple running tallies using a per-sample bin index. This can be useful, for example, in accumulating statistics over samples by some kind of "type" index or for accumulating statistics per-graph in a pytorch_geometric-like batching scheme. (This feature is similar to torch_scatter.)
  • Option to ignore NaN values with correct sample counting.

Note: the implementations currently heavily uses in-place operations for peformance and memory efficiency. This probably doesn't play nice with the autograd engine — this is currently likely the wrong library for accumulating running statistics you want to backward through. (See TorchMetrics for a possible alternative.)

For more information, please see the docs.

Install

torch_runstats requires PyTorch.

The library can be installed from PyPI:

$ pip install torch_runstats

The latest development version of the code can also be installed from git:

$ git clone https://github.com/mir-group/pytorch_runstats

and install it by running

$ cd torch_runstats/
$ pip install .

You can run the tests with

$ pytest tests/

License

pytorch_runstats is distributed under an MIT 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

torch_runstats-0.2.0.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

torch_runstats-0.2.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file torch_runstats-0.2.0.tar.gz.

File metadata

  • Download URL: torch_runstats-0.2.0.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for torch_runstats-0.2.0.tar.gz
Algorithm Hash digest
SHA256 bc7f32887103c820bd7cc710b9c476d1ec56a68a3ff9a42b9b56758bfb8afd97
MD5 d4f0aaf3d30fcc385dc3221ac8c473d2
BLAKE2b-256 100f0b7710b63cf4fe09c8710db208a2c5cf66b1e09efbbcae0adc6fcf149caa

See more details on using hashes here.

File details

Details for the file torch_runstats-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: torch_runstats-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for torch_runstats-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ba5a5214e1154aac8cca383943e7a9029e412f62e663002ede9c3dd19b947847
MD5 6243ea64088c0556512f4fcc65cf9ac4
BLAKE2b-256 4f81021f56cdddce39a04c51abfd17af52f3fba91d30b699af5e5352f8abbff6

See more details on using hashes here.

Supported by

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