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.9.tar.gz (220.2 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for frame_averaging_pytorch-0.0.9.tar.gz
Algorithm Hash digest
SHA256 c3ca4b7ccf16a3c0691db48d173c3288968de09cf8a26834ffebe06629a5b344
MD5 338488b13b1dcadfa1b954a76e20848d
BLAKE2b-256 2ae041cd6227d76c8b83fd6fce9d7f2adaeb2de2c4dfe2ac88b98f8533ba1e35

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for frame_averaging_pytorch-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 a64b3432b7d90b8b2bab679a3d9977b3734e6416168300d3566e87df8a267c0c
MD5 9d1e6e24bc11a75c3c48da9f02e02e44
BLAKE2b-256 0c83d7d3ce7110dee19a84cbb41903965962012b41c86411b16cf24b050114e1

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