Updated gpu-stimp docstring for RTD

Author: seanlaw

docs/api.rst

@@ -47,7 +47,7 @@ stumped
 gpu_stump
 =========
 
-.. autofunction:: stumpy.gpu_stump(T_A, m, T_B=None, ignore_trivial=True, device_id=0, normalize=True)
+.. autofunction:: stumpy.gpu_stump(T_A, m, T_B=None, ignore_trivial=True, device_id=0, normalize=True, p=2.0)
 
 mass
 ====
@@ -115,7 +115,7 @@ ostinatoed
 gpu_ostinato
 ============
 
-.. autofunction:: stumpy.gpu_ostinato(Ts, m, device_id=0, normalize=True)
+.. autofunction:: stumpy.gpu_ostinato(Ts, m, device_id=0, normalize=True, p=2.0)
 
 mpdist
 ======
@@ -130,7 +130,7 @@ mpdisted
 gpu_mpdist
 ==========
 
-.. autofunction:: stumpy.gpu_mpdist(T_A, T_B, m, percentage=0.05, k=None, device_id=0, normalize=True)
+.. autofunction:: stumpy.gpu_mpdist(T_A, T_B, m, percentage=0.05, k=None, device_id=0, normalize=True, p=2.0)
 
 motifs
 ======
@@ -160,5 +160,5 @@ stimped
 gpu_stimp
 =========
 
-.. autofunction:: stumpy.gpu_stimp(T, min_m=3, max_m=None, step=1, device_id=0)
+.. autofunction:: stumpy.gpu_stimp(T, min_m=3, max_m=None, step=1, device_id=0, normalize=True, p=2.0)
 

stumpy/__init__.py

@@ -142,6 +142,7 @@
     # Fix GPU-STIMP Docs
     # Note that this is a special case for class definitions.
     # See above for function definitions.
+    # Also, please update docs/api.rst
     gpu_stimp.__doc__ = ""
     filepath = pathlib.Path(__file__).parent / "gpu_stimp.py"
 
@@ -153,6 +154,22 @@
     for cd in class_definitions:
         if cd.name == "gpu_stimp":
             gpu_stimp.__doc__ = ast.get_docstring(cd)
+    
+    # Fix GPU-AAMP-STIMP Docs
+    # Note that this is a special case for class definitions.
+    # See above for function definitions.
+    # Also, please update docs/api.rst
+    gpu_aamp_stimp.__doc__ = ""
+    filepath = pathlib.Path(__file__).parent / "gpu_aamp_stimp.py"
+
+    file_contents = ""
+    with open(filepath, encoding="utf8") as f:
+        file_contents = f.read()
+    module = ast.parse(file_contents)
+    class_definitions = [node for node in module.body if isinstance(node, ast.ClassDef)]
+    for cd in class_definitions:
+        if cd.name == "gpu_aamp_stimp":
+            gpu_aamp_stimp.__doc__ = ast.get_docstring(cd)
 
 try:
     _dist = get_distribution("stumpy")