Merge main into dev (#128)

* Adding funding statement * Add requirements to docs (#107) * add requirements to docs * remove myst_parser req * Update requirements.txt * Update conf.py * Update docs.yaml (#108) * Update docs.yaml * Update docs.yaml (#109) * simplify torch dependencies (#122) * simplify torch dependency * remove python constratints * fix pre-commit * Merge `dev` into `main` for 0.4.2 release (#123) * re-implement distributions using torch.distributions (#110) * loosely re-implement distributions using torch.distributions * further enhancement * rename * log_uniform as transformed dist * delete uniform and log_normal since they are already implemented * bring back LogNormal, change parameter sampler * add delta function distribution, minor fixes to other distributions * fix * Initial commit of q-transform * Added a MultiQTransform * Reparameterized to number of t and f bins * Re-factored SingleQTransform to allow for eventually using different q's for batch/channels * Changed interpolation to better match gwpy and added option to specify frequency range in which to search for max energy tile * Added QScan to __init__ * Changed from torch median to quantile to match numpy median * Added documentation to qtransform * Added gwpy to dev dependencies * Added tests and corrected get_freqs bug * Changed method of normalization and updated documentation * Updated more documentation and changed interpolation method * Changed how interpolation shape is parameterized * Reverted documentation to state expectation of 3D input * Fixed type hint for spectrogram_shape in qtransform * Switched tuple to Tuple * `InMemoryDataset` improvements (#119) * in memory dataset inherits from torch iterable dataset * pre-commit issues * fix yielding logic * fix in memory dataset tests * handle deprecated transpose ops in phenomd (#120) * Torch dependency fix into dev (#124) * udpate poetry lock * increment version once more * re add gwpy dev dep * update poetry lock * fix poetry conflic * fix poety conflict * Poetry fix (#126) * remove gwpy dep for now * poetry lock file --------- Co-authored-by: Deep Chatterjee <[email protected]> Co-authored-by: wbenoit26 <[email protected]> Co-authored-by: William Benoit <[email protected]> Co-authored-by: William Benoit <[email protected]> * increment version (#127) --------- Co-authored-by: wbenoit26 <[email protected]> Co-authored-by: Deep Chatterjee <[email protected]> Co-authored-by: William Benoit <[email protected]> Co-authored-by: William Benoit <[email protected]>
ML4GW · May 14, 2024 · b866869 · b866869
1 parent df1ebdc
commit b866869
Show file tree

Hide file tree

Showing 6 changed files with 206 additions and 29 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -8,11 +8,23 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
-    - 
-      name: Build docs
-      uses: ammaraskar/sphinx-action@master
+    - name: Setup python
+      id: setup-python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
       with:
-        docs-folder: "docs/"
+        virtualenvs-create: false
+        virtualenvs-in-project: false
+        installer-parallel: true
+    - name: Install and Build Docs
+      run: |
+        poetry install
+        cd docs
+        make clean
+        make html
     - 
       name: Deploy pages
       uses: JamesIves/[email protected]

diff --git a/README.md b/README.md
@@ -130,3 +130,6 @@ We encourage users who encounter these difficulties to file issues on GitHub, an
 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 [[email protected]](mailto:[email protected]) .
 By bringing in new users with new use cases, we hope to develop this library into a truly general-purpose tool which makes DL 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 <a href="https://a3d3.ai">Accelerating AI Algorithms for Data Driven Discovery (A3D3)</a> under Cooperative Agreement No. <a href="https://www.nsf.gov/awardsearch/showAward?AWD_ID=2117997">PHY-2117997</a>.
diff --git a/docs/conf.py b/docs/conf.py
@@ -10,9 +10,10 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../"))
 
 
 # -- Project information -----------------------------------------------------
@@ -31,25 +32,9 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx_autodoc_typehints",
-    "myst_parser",
     "sphinx.ext.githubpages",
 ]
 
-myst_enable_extensions = [
-    "amsmath",
-    "colon_fence",
-    "deflist",
-    "dollarmath",
-    "fieldlist",
-    "html_admonition",
-    "html_image",
-    "linkify",
-    "replacements",
-    "smartquotes",
-    "strikethrough",
-    "substitution",
-    "tasklist",
-]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+sphinx-rtd-theme>=2.0.0
+sphinx-autodoc-typehints>=2.0.0
+docutils>=0.17
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ml4gw"
-version = "0.4.1"
+version = "0.4.2"
 description = "Tools for training torch models on gravitational wave data"
 readme = "README.md"
 authors = [
@@ -23,6 +23,7 @@ pytest = "^7.0"
 lalsuite = "^7.0"
 bilby = "^2.1"
 jupyter = "^1.0.0"
+gwpy = "^2.1"
 
 Sphinx = ">5.0"
 sphinx-rtd-theme = "^2.0.0"