From 5802065208e3d9c2c1ed4a5a5046593bc12e65b1 Mon Sep 17 00:00:00 2001
From: Tianbao Xie <47296835+Timothyxxx@users.noreply.github.com>
Date: Mon, 11 Nov 2024 12:41:25 +0800
Subject: [PATCH] docs: add cleanup instruction for residual docker containers

docs: add note about cleaning up residual docker containers

Add note in README about cleaning up residual docker containers after abnormal experiment interruption to prevent performance issues
---
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.md b/README.md
index c36d3d6..6d257cd 100644
--- a/README.md
+++ b/README.md
@@ -89,6 +89,7 @@ If your hosting platform supports a graphical user interface (GUI), you may refe
 Add the following arguments when initializing `DesktopEnv`: 
 - `provider_name`: `docker`
 - `os_type`: `Ubuntu` or `Windows`, depending on the OS of the VM
+> **Note**: If the experiment is interrupted abnormally (e.g., by interrupting signals), there may be residual docker containers which could affect system performance over time. Please run `docker stop $(docker ps -q) && docker rm $(docker ps -a -q)` to clean up.
 
 ### Others
 We are working on supporting more 👷. Please hold tight!