Adding docstring to AutoEmulate class to ensure generation of docs

alan-turing-institute · Feb 14, 2024 · 8672083 · 8672083
1 parent 25d0812
commit 8672083
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/autoemulate/compare.py b/autoemulate/compare.py
@@ -27,6 +27,12 @@
 
 
 class AutoEmulate:
+    """
+    The AutoEmulate class is the main class of the AutoEmulate package. It is used to set up and compare
+    different emulator models on a given dataset. It can also be used to save and load models, and to
+    print and plot the results of the comparison.
+    """
+
     def __init__(self):
         """Initializes an AutoEmulate object."""
         self.X = None