Data

Tools

Indexes

Applications

Experiments

Open Source Science

ml4gw

Torch utilities for doing machine learning in gravitational wave physics

https://github.com/ml4gw/ml4gw

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary
Last synced: 8 months ago · JSON representation ·

Repository

Torch utilities for doing machine learning in gravitational wave physics

Basic Info
  • Host: GitHub
  • Owner: ML4GW
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Size: 8.81 MB
Statistics
  • Stars: 27
  • Watchers: 3
  • Forks: 19
  • Open Issues: 30
  • Releases: 19
Created over 3 years ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md

ML4GW

PyPI - Version PyPI - Python Version GitHub License Test status Coverage badge

Torch utilities for training neural networks in gravitational wave physics applications.

Documentation

Please visit our documentation page to see descriptions and examples of the functions and modules available in ml4gw. We also have an interactive Jupyter notebook that demonstrates much of the core functionality available in the examples directory.

Installation

Pip installation

You can install ml4gw with pip:

console pip install ml4gw

To build with a specific version of PyTorch/CUDA, please see the PyTorch installation instructions here to see how to specify the desired torch version and --extra-index-url flag. For example, to install with torch 2.5.1 and CUDA 11.8 support, you would run

console pip install ml4gw torch==2.5.1--extra-index-url=https://download.pytorch.org/whl/cu118

Contributing

If you come across errors in the code, have difficulties using this software, or simply find that the current version doesn't cover your use case, please file an issue on our GitHub page, and we'll be happy to offer support. We encourage users who encounter these difficulties to file issues on GitHub, and we'll be happy to offer support to extend our coverage to new or improved functionality. We also strongly encourage ML users in the GW physics space to try their hand at working on these issues and joining on as collaborators! For more information about how to get involved, feel free to reach out to ml4gw@ligo.mit.edu. By bringing in new users with new use cases, we hope to develop this library into a truly general-purpose tool that makes deep learning more accessible for gravitational wave physicists everywhere.

Funding

We are grateful for the support of the U.S. National Science Foundation (NSF) Harnessing the Data Revolution (HDR) Institute for Accelerating AI Algorithms for Data Driven Discovery (A3D3) under Cooperative Agreement No. PHY-2117997.

Owner

  • Name: ML4GW
  • Login: ML4GW
  • Kind: organization

JOSS Publication

ml4gw: PyTorch utilities for training neural networks in gravitational wave physics applications
Published
October 21, 2025
DOI
Volume 10, Issue 114, Page 8836
Authors
William Benoit ORCID
University of Minnesota, USA
Ethan Marx ORCID
Massachusetts Institute of Technology, USA, MIT LIGO Laboratory, USA
Deep Chatterjee ORCID
Massachusetts Institute of Technology, USA, MIT LIGO Laboratory, USA
Ravi Kumar
Indian Institute of Technology Bombay, India
Alec Gunny
Massachusetts Institute of Technology, USA, MIT LIGO Laboratory, USA
Editor
Jack Atkinson ORCID
Tags
PyTorch machine learning gravitational waves signal processing
View PDF Review Thread Software Archive

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: ml4gw
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Ethan
    family-names: Marx
    email: emarx@mit.edu
    affiliation: MIT
    orcid: 'https://orcid.org/0009-0000-4183-7876'
  - given-names: William
    family-names: Benoit
    email: benoi090@umn.edu
    affiliation: University of Minnesota
    orcid: 'https://orcid.org/0000-0003-4750-9413'
  - given-names: Deep
    family-names: Chatterjee
    email: deep1018@mit.edu
    affiliation: MIT
    orcid: 'https://orcid.org/0000-0003-0038-5468'
  - given-names: Ravi
    family-names: Kumar
    email: ravi.kr@iitb.ac.in
    affiliation: Indian Institute of Technology Bombay
  - given-names: Alec
    family-names: Gunny
repository-code: 'https://github.com/ML4GW/ml4gw'
abstract: >-
  Torch utilities for doing machine learning in gravitational wave physics
keywords:
  - Gravitational waves
  - Machine learning

GitHub Events

Total
  • Create event: 19
  • Release event: 11
  • Issues event: 10
  • Watch event: 9
  • Delete event: 6
  • Issue comment event: 109
  • Push event: 114
  • Pull request review comment event: 53
  • Pull request event: 92
  • Pull request review event: 77
  • Fork event: 4
Last Year
  • Create event: 19
  • Release event: 11
  • Issues event: 10
  • Watch event: 9
  • Delete event: 6
  • Issue comment event: 109
  • Push event: 114
  • Pull request review comment event: 53
  • Pull request event: 92
  • Pull request review event: 77
  • Fork event: 4

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 5
  • Total pull requests: 40
  • Average time to close issues: 9 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 4
  • Total pull request authors: 6
  • Average comments per issue: 1.0
  • Average comments per pull request: 1.9
  • Merged pull requests: 28
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 40
  • Average time to close issues: 2 months
  • Average time to close pull requests: 3 days
  • Issue authors: 2
  • Pull request authors: 6
  • Average comments per issue: 1.33
  • Average comments per pull request: 1.9
  • Merged pull requests: 28
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • EthanMarx (6)
  • alecgunny (3)
  • deepchatterjeeligo (3)
  • wbenoit26 (1)
  • AndyC80297 (1)
  • ravioli1369 (1)
  • asasli (1)
Pull Request Authors
  • EthanMarx (45)
  • wbenoit26 (34)
  • deepchatterjeeligo (13)
  • ravioli1369 (11)
  • AndyC80297 (5)
  • sjhend03 (1)
  • tblodg23 (1)
  • alecgunny (1)
  • asasli (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 805 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 4
  • Total versions: 21
  • Total maintainers: 1
pypi.org: ml4gw

Tools for training torch models on gravitational wave data

  • Versions: 21
  • Dependent Packages: 0
  • Dependent Repositories: 4
  • Downloads: 805 Last month
Rankings
Dependent repos count: 7.5%
Dependent packages count: 10.0%
Average: 19.6%
Downloads: 41.3%
Maintainers (1)
ml4gw
Last synced: 8 months ago

Dependencies

poetry.lock pypi
  • atomicwrites 1.4.1 develop
  • cfgv 3.3.1 develop
  • distlib 0.3.6 develop
  • filelock 3.8.0 develop
  • identify 2.5.3 develop
  • iniconfig 1.1.1 develop
  • lalsuite 7.7 develop
  • lscsoft-glue 3.0.1 develop
  • nodeenv 1.7.0 develop
  • platformdirs 2.5.2 develop
  • pluggy 1.0.0 develop
  • pre-commit 2.20.0 develop
  • py 1.11.0 develop
  • pyopenssl 22.0.0 develop
  • pyrxp 3.0.1 develop
  • pytest 7.1.2 develop
  • toml 0.10.2 develop
  • virtualenv 20.16.4 develop
  • astropy 5.1
  • attrs 22.1.0
  • bilby 1.2.0
  • certifi 2022.6.15
  • cffi 1.15.1
  • charset-normalizer 2.1.1
  • colorama 0.4.5
  • corner 2.2.1
  • cryptography 37.0.4
  • cycler 0.11.0
  • dill 0.3.5.1
  • dqsegdb2 1.1.2
  • dynesty 1.0.1
  • emcee 3.1.2
  • fonttools 4.37.1
  • gwdatafind 1.1.1
  • gwosc 0.6.1
  • gwpy 2.1.5
  • h5py 3.7.0
  • idna 3.3
  • igwn-auth-utils 0.2.3
  • kiwisolver 1.4.4
  • ligo-segments 1.4.0
  • ligotimegps 2.0.1
  • matplotlib 3.5.3
  • numpy 1.23.2
  • packaging 21.3
  • pandas 1.4.4
  • pillow 9.2.0
  • pycparser 2.21
  • pyerfa 2.0.0.1
  • pyjwt 2.4.0
  • pyparsing 3.0.9
  • python-dateutil 2.8.2
  • pytz 2022.2.1
  • pyyaml 6.0
  • requests 2.28.1
  • safe-netrc 1.0.0
  • scipy 1.9.1
  • scitokens 1.7.0
  • setuptools 65.3.0
  • setuptools-scm 6.4.2
  • six 1.16.0
  • tomli 2.0.1
  • torch 1.12.1
  • torchtyping 0.1.4
  • tqdm 4.64.0
  • typeguard 2.13.3
  • typing-extensions 4.3.0
  • urllib3 1.26.12
pyproject.toml pypi
  • bilby ^1.1
  • gwpy ^2.1
  • python >=3.8,<3.11
  • torch ^1.10
  • torchtyping ^0.1
.github/workflows/pre-commit.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pre-commit/action v2.0.3 composite
.github/workflows/unit-tests.yaml actions
  • JRubics/poetry-publish v1.16 composite
  • abatilo/actions-poetry v2.0.0 composite
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/publish.yaml actions
  • JRubics/poetry-publish v1.16 composite
  • actions/checkout v2 composite