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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for frame_averaging_pytorch-0.0.7.tar.gz
Algorithm Hash digest
SHA256 d4726d986cfc9e3a5571e1a0224702f8b4ec42b40af0e4c9464bb187b15a4435
MD5 888373e683d0d6c716663aae9c67dbac
BLAKE2b-256 304ec7abab5072b2321541327f539c103b074692f58e99cbae3d1ec1424ec78d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for frame_averaging_pytorch-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 774c4fbd987636fce61beb6bed952453cf6eb37b78726ba6e596e096cb69e85f
MD5 33ae8ca40c8996193c6f3eea919f57e0
BLAKE2b-256 7363f7fc559873bacd127fd3b25981f58d53b24ac40cdd432ce6aeb9f0212bc8

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