From b523b27d5a52c664484ab992f51c19b8756190ea Mon Sep 17 00:00:00 2001
From: lzh222333 <lzh222333@163.com>
Date: Tue, 29 Jun 2021 10:37:09 +0000
Subject: [PATCH] add docstring

---
 qlib/workflow/recorder.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/qlib/workflow/recorder.py b/qlib/workflow/recorder.py
index 1bb8bea6e..7edb0ebb9 100644
--- a/qlib/workflow/recorder.py
+++ b/qlib/workflow/recorder.py
@@ -309,6 +309,18 @@ class MLflowRecorder(Recorder):
             shutil.rmtree(temp_dir)
 
     def load_object(self, name):
+        """
+        Load object such as prediction file or model checkpoint in mlflow.
+
+        Args:
+            name (str): the object name
+
+        Raises:
+            LoadObjectError: if raise some exceptions when load the object
+
+        Returns:
+            object: the saved object in mlflow.
+        """
         assert self.uri is not None, "Please start the experiment and recorder first before using recorder directly."
 
         try: