tests passing

cgoliver · Sep 10, 2024 · 86ea1da · 86ea1da
1 parent ea9c4cb
commit 86ea1da
Show file tree

Hide file tree

Showing 19 changed files with 454 additions and 2,461 deletions.
diff --git a/docs/source/rnaglib.algorithms.rst b/docs/source/rnaglib.algorithms.rst
@@ -2,7 +2,6 @@
 ========================
 
 
-
 .. automodule:: rnaglib.algorithms
 
 

diff --git a/docs/source/rnaglib.data_loading.rst b/docs/source/rnaglib.data_loading.rst
@@ -1,10 +1,37 @@
 ``rnaglib.data_loading``
 =========================
 
+Tools for loading and creating collections of RNAs.
 
-.. currentmodule:: rnaglib.data_loading
+.. automodule:: rnaglib.data_loading
 
 
-.. automodule:: rnaglib.data_loading
-    :members:
 
+RNA Dataset
+--------------
+
+
+This is the main object used for holding collections of RNAs. The ``RNAdataset`` object draws from a database.
+
+.. autosummary::
+   :toctree: generated/
+
+    RNADataset
+
+
+
+Loading
+---------
+
+Tools for loading RNAs stored in an ``RNADataset`` batch-wise for deep learning models.
+
+
+
+.. autosummary::
+   :toctree: generated/
+
+    Collater
+    get_loader
+    get_inference_loader
+    EdgeLoaderGenerator 
+    DefaultBasePairLoader
diff --git a/docs/source/rnaglib.prepare_data.rst b/docs/source/rnaglib.prepare_data.rst
@@ -1,7 +1,9 @@
 ``rnaglib.prepare_data``
 =============================
 
-Functions to build data releases from raw PDBs.
+Constructing databases of RNAs along with their annotations. The resulting
+databases are stored in a local folder and accessed by ``RNADataset`` to build
+datasets.
 
 .. currentmodule:: rnaglib.prepare_data