From 0a89f48fb94f6cef95818f246f89b85c76a4c6b1 Mon Sep 17 00:00:00 2001
From: Tavish <tavish9.chen@gmail.com>
Date: Thu, 20 Feb 2025 17:15:46 +0800
Subject: [PATCH] update README.md

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index e37d148..c2aed14 100644
--- a/README.md
+++ b/README.md
@@ -82,6 +82,18 @@ pip install -e .
 
 ## Get started
 
+> [!IMPORTANT]  
+> Before running the following code, modify `consolidate()` function in lerobot.
+> ```python
+> def consolidate(self, run_compute_stats: bool = True, keep_image_files: bool = False, stat_kwargs: dict = {}) -> None:
+>     ...
+>     if run_compute_stats:
+>         self.stop_image_writer()
+>         # TODO(aliberts): refactor stats in save_episodes
+>         self.meta.stats = compute_stats(self, **stat_kwargs)
+>     ...
+> ```
+
 Download source code:
 
 ```bash