Skip to main content

torchfunc Logo


Version Docs Tests Coverage Style PyPI Python PyTorch Docker Roadmap
Version Documentation Tests codebeat PyPI Python PyTorch Docker Roadmap

torchfunc is library revolving around PyTorch with a goal to help you with:

  • Improving and analysing performance of your neural network
  • Daily neural network duties (model size, seeding, performance measurements etc.)
  • Plotting and visualizing modules
  • Record neuron activity and tailor it to your specific task or target
  • Get information about your host operating system, CUDA devices and others

Quick examples

  • Seed globaly, Freeze weights, check inference time and model size
# Inb4 MNIST, you can use any module with those functions
model = torch.nn.Linear(784, 10)
frozen = torchfunc.module.freeze(model, bias=False)

with torchfunc.Timer() as timer:
  frozen(torch.randn(32, 784)
  print(timer.checkpoint()) # Time since the beginning
  frozen(torch.randn(128, 784)
  print(timer.checkpoint()) # Since last checkpoint

print(f"Overall time {timer}; Model size: {torchfunc.sizeof(frozen)}")
  • Recorder and sum per-layer activation statistics as data passes through network:
# MNIST classifier
model = torch.nn.Sequential(
    torch.nn.Linear(784, 100),
    torch.nn.ReLU(),
    torch.nn.Linear(100, 50),
    torch.nn.ReLU(),
    torch.nn.Linear(50, 10),
)
# Recorder which sums layer inputs from consecutive forward calls
recorder = torchfunc.record.ForwardPreRecorder(reduction=lambda x, y: x+y)
# Record inputs going into Linear(100, 50) and Linear(50, 10)
recorder.children(model, indices=(2, 3))
# Train your network normally (or pass data through it)
...
# Save tensors (of shape 100 and 50) in folder, each named 1.pt and 2.pt respectively
recorder.save(pathlib.Path("./analysis"))

For performance tips, plotting and other check torchfunc documentation.

Installation

pip

Latest release:

pip install --user torchfunc

Nightly:

pip install --user torchfunc-nightly

Docker

CPU standalone and various versions of GPU enabled images are available at dockerhub.

For CPU quickstart, issue:

docker pull szymonmaszke/torchfunc:18.04

Nightly builds are also available, just prefix tag with nightly_. If you are going for GPU image make sure you have nvidia/docker installed and it's runtime set.

Contributing

If you find any issue or you think some functionality may be useful to others and fits this library, please open new Issue or create Pull Request.

To get an overview of something which one can done to help this project, see Roadmap

Metadata

Release files for torchfunc-nightly 1569222144

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for torchfunc-nightly 1569222144
File Size Uploaded Provenance Actions
torchfunc-nightly-1569222144.tar.gz 19.9 kB Without provenance Details for torchfunc-nightly-1569222144.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for torchfunc-nightly 1569222144
File Interpreter ABI Platform Actions
torchfunc_nightly-1569222144-py3-none-any.whl Python 3 none any Details for torchfunc_nightly-1569222144-py3-none-any.whl

Total release size: 44.8 kB

Release files / torchfunc-nightly-1569222144.tar.gz

Download URL torchfunc-nightly-1569222144.tar.gz
Size 19.9 kB
Tags Source
SHA-256 checksum
How to use checksums
17a2dc404b387a8a0e0770d444486257894f94d5a12531b233fe732a645bc9dc
BLAKE2b-256 checksum
How to use checksums
59fdc9834194a14423f950a2f519e663897849e23cd5f4a91e6a53ce497e1e47
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Release files / torchfunc_nightly-1569222144-py3-none-any.whl

Download URL torchfunc_nightly-1569222144-py3-none-any.whl
Size 25.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
68d072f6da8471aabb64c370db741d276824abbe7a28993dce260e4c07b706be
BLAKE2b-256 checksum
How to use checksums
2d603ba516b5a98a35a6e8ec5a0ac458946d4f66717d374afdb3489529399146
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Security for torchfunc-nightly 1569222144

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1569222144 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page