fix Readme.md

logicalclocks · Nov 5, 2020 · 68f0927 · 68f0927
1 parent 88314d8
commit 68f0927
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -69,6 +69,11 @@ Upsert new data in to the feature group with `time_travel_format="HUDI"`".
 fg.insert(upsert_df, operation)
 ```
 
+Retrieve commit timeline metdata of the feature group with `time_travel_format="HUDI"`".
+```python
+fg.commit_details()
+```
+
 "Reading feature group as of specific point in time".
 ```python
 fg = fs.get_feature_group("rain", 1)

diff --git a/python/hsfs/feature_group.py b/python/hsfs/feature_group.py
@@ -380,6 +380,10 @@ def commit_details(self, limit: Optional[int] = None):
         # Arguments
             limit: Number of commits to retrieve. Defaults to `None`.
 
+        # Returns
+            `Dict[str, Dict[str, str]]`. Dictionary object of commit metadata timeline, where Key is commit id and value
+            is `Dict[str, str]` with key value pairs of date committed on, number of rows updated, inserted and deleted.
+
         # Raises
             `RestAPIError`.
         """