Improve and analyse performance of your neural network (e.g. Tensor Cores compatibility)
Record/analyse internal state of torch.nn.Module as data passes through it
Do the above based on external conditions (using single Callable to specify it)
Day-to-day neural network related duties (model size, seeding, time measurements etc.)
Get information about your host operating system, torch.nn.Module device, CUDA capabilities etc.

Version	Docs	Tests	Coverage	Style	PyPI	Python	PyTorch	Docker	Roadmap

:bulb: Examples

Check documentation here: https://szymonmaszke.github.io/torchfunc

1. Getting performance tips

Get instant performance tips about your module. All problems described by comments will be shown by torchfunc.performance.tips:

class Model(torch.nn.Module):
    def __init__(self):
        super().__init__()
        self.convolution = torch.nn.Sequential(
            torch.nn.Conv2d(1, 32, 3),
            torch.nn.ReLU(inplace=True),  # Inplace may harm kernel fusion
            torch.nn.Conv2d(32, 128, 3, groups=32),  # Depthwise is slower in PyTorch
            torch.nn.ReLU(inplace=True),  # Same as before
            torch.nn.Conv2d(128, 250, 3),  # Wrong output size for TensorCores
        )

        self.classifier = torch.nn.Sequential(
            torch.nn.Linear(250, 64),  # Wrong input size for TensorCores
            torch.nn.ReLU(),  # Fine, no info about this layer
            torch.nn.Linear(64, 10),  # Wrong output size for TensorCores
        )

    def forward(self, inputs):
        convolved = torch.nn.AdaptiveAvgPool2d(1)(self.convolution(inputs)).flatten()
        return self.classifier(convolved)

# All you have to do
print(torchfunc.performance.tips(Model()))

2. Seeding, weight freezing and others

Seed globaly (including numpy and cuda), freeze weights, check inference time and model size:

# Inb4 MNIST, you can use any module with those functions
model = torch.nn.Linear(784, 10)
torchfunc.seed(0)
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)}")

3. Record `torch.nn.Module` internal state

Record and sum per-layer activation statistics as data passes through network:

# Still MNIST but any module can be put in it's place
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 all inputs to layers
recorder = torchfunc.hooks.recorders.ForwardPre(reduction=lambda x, y: x+y)
# Record only for torch.nn.Linear
recorder.children(model, types=(torch.nn.Linear,))
# Train your network normally (or pass data through it)
...
# Activations of all neurons of first layer!
print(recorder[1]) # You can also post-process this data easily with apply

For other examples (and how to use condition), see documentation

:wrench: Installation

:snake: pip

Latest release:

pip install --user torchfunc

Nightly:

pip install --user torchfunc-nightly

:whale2: 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.

:question: 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 things one can do to help this project, see Roadmap.

Metadata

Release files for torchfunc-nightly 1663034600

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 1663034600
File	Size	Uploaded
torchfunc-nightly-1663034600.tar.gz	24.5 kB	Sep 13, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for torchfunc-nightly 1663034600
File	Interpreter	ABI	Platform	Reset
torchfunc_nightly-1663034600-py3-none-any.whl 31.0 kB Sep 13, 2022	Python 3	none	any	Details

Total release size: 55.5 kB

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

Download URL	torchfunc-nightly-1663034600.tar.gz
Size	24.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`8751db94a928be26c9e664de4010a10d263824fdd724412293d577b9cc56704c`
BLAKE2b-256 checksum How to use checksums	`d14fab187f42f60ca8a06bf1e22832fd52e9990326698bd4834baa833829f217`
Upload date	Sep 13, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.9.14`

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

Download URL	torchfunc_nightly-1663034600-py3-none-any.whl
Size	31.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`820f6f9d554afecfe2e9bef395986f4c81d2c50a400adb081b9e21cc99ab76b3`
BLAKE2b-256 checksum How to use checksums	`4023b79181fcae8c09a2f393974d15822333ab8b89ddcef7ba9af9a583bda581`
Upload date	Sep 13, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.9.14`