Fixing Doc Conf (#49)

awslabs · Nov 28, 2022 · f3e9302 · f3e9302
1 parent ce93579
commit f3e9302
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -7,9 +7,9 @@
 import shutil
 import sys
 
-import renate
+sys.path.insert(0, os.path.abspath("../src/"))
 
-sys.path.insert(0, os.path.abspath("."))
+import renate
 
 
 def run_apidoc(app):

diff --git a/src/renate/data/data_module.py b/src/renate/data/data_module.py
@@ -20,8 +20,7 @@ class RenateDataModule(abc.ABC):
 
     A data module implements two methods for data preparation:
     - `prepare_data()` downloads the data to the local machine and unpacks it.
-    - `setup()` creates pytorch dataset objects that return training, test and (possibly) validation
-      data.
+    - `setup()` creates pytorch dataset objects that return training, test and (possibly) validation data.
     These two steps are separated to streamline the process when launching multiple training jobs
     simultaneously, e.g., for hyperparameter optimization. In this case, `prepare_data()` is only
     called once per machine.