Skip to main content

Frame Averaging

Project description

Frame Averaging - Pytorch (wip)

Pytorch implementation of a simple way to enable (Stochastic) Frame Averaging for any network. This technique was recently adopted by Prescient Design in AbDiffuser

Install

$ pip install frame-averaging-pytorch

Usage

import torch
from frame_averaging_pytorch import FrameAverage

# contrived neural network

net = torch.nn.Linear(3, 3)

# wrap the network with FrameAverage

net = FrameAverage(
    net,
    dim = 3,           # defaults to 3 for spatial, but can be any value
    stochastic = True  # whether to use stochastic variant from FAENet (one frame sampled at random)
)

# pass your input to the network as usual

points = torch.randn(2, 4, 1024, 3)

out = net(points)

out.shape # (2, 4, 1024, 3)

# frame averaging is automatically taken care of, as though the network were unwrapped

Citations

@article{Puny2021FrameAF,
    title   = {Frame Averaging for Invariant and Equivariant Network Design},
    author  = {Omri Puny and Matan Atzmon and Heli Ben-Hamu and Edward James Smith and Ishan Misra and Aditya Grover and Yaron Lipman},
    journal = {ArXiv},
    year    = {2021},
    volume  = {abs/2110.03336},
    url     = {https://api.semanticscholar.org/CorpusID:238419638}
}
@article{Duval2023FAENetFA,
    title   = {FAENet: Frame Averaging Equivariant GNN for Materials Modeling},
    author  = {Alexandre Duval and Victor Schmidt and Alex Hernandez Garcia and Santiago Miret and Fragkiskos D. Malliaros and Yoshua Bengio and David Rolnick},
    journal = {ArXiv},
    year    = {2023},
    volume  = {abs/2305.05577},
    url     = {https://api.semanticscholar.org/CorpusID:258564608}
}

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

frame_averaging_pytorch-0.0.8.tar.gz (220.2 kB view details)

Uploaded Source

Built Distribution

frame_averaging_pytorch-0.0.8-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file frame_averaging_pytorch-0.0.8.tar.gz.

File metadata

File hashes

Hashes for frame_averaging_pytorch-0.0.8.tar.gz
Algorithm Hash digest
SHA256 da802bd625bbe292ebaf62d00c109d9cc0f0e4b4e99aed0e617a16d4dd1396d2
MD5 b9726a9ade63ae8416c9a0a1d8879293
BLAKE2b-256 11b90f6a52b67cddbeca289dcdfde65e20ef228207db4e2971c63d8673a5a8a7

See more details on using hashes here.

File details

Details for the file frame_averaging_pytorch-0.0.8-py3-none-any.whl.

File metadata

File hashes

Hashes for frame_averaging_pytorch-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 19b4f667b2c8857394259c7bd4e739fc43874ee64ae850d641d93d291db7a02e
MD5 e2fa1ff1f4286e9c7d1e5ef55586436d
BLAKE2b-256 b07c051bd501cb8f95e1963f40d6178e92915db60ddcb98f71410ce62a48e08c

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