From f564b5761766b16a4db13508f0acd1bc911afb8d Mon Sep 17 00:00:00 2001
From: Xiaohan Mao <30319236+mxh1999@users.noreply.github.com>
Date: Thu, 9 May 2024 15:52:06 +0800
Subject: [PATCH] [Fix] Add the command in the README for the single-GPU case
 (#48)

* Implement portable eval script for server

* lint format

* implement visualizer for debugging

* Update README

* docstring

* Refine some docstrings.

* refine docstring

* refine docstring

* update README for single gpu training/testing
---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 23be45f..b3eced6 100644
--- a/README.md
+++ b/README.md
@@ -180,6 +180,10 @@ We provide configs for different tasks [here](configs/) and you can run the trai
 For example, to train a multi-view 3D detection model with pytorch, just run:
 
 ```bash
+# Single GPU training
+python tools/train.py configs/detection/mv-det3d_8xb4_embodiedscan-3d-284class-9dof.py --work-dir=work_dirs/mv-3ddet
+
+# Multiple GPU training
 python tools/train.py configs/detection/mv-det3d_8xb4_embodiedscan-3d-284class-9dof.py --work-dir=work_dirs/mv-3ddet --launcher="pytorch"
 ```
 
@@ -190,6 +194,10 @@ NOTE: To run the multi-view 3D grounding experiments, please first download the
 To inference and evaluate the model (e.g., the checkpoint `work_dirs/mv-3ddet/epoch_12.pth`), just run the test script:
 
 ```bash
+# Single GPU testing
+python tools/test.py configs/detection/mv-det3d_8xb4_embodiedscan-3d-284class-9dof.py work_dirs/mv-3ddet/epoch_12.pth
+
+# Multiple GPU testing
 python tools/test.py configs/detection/mv-det3d_8xb4_embodiedscan-3d-284class-9dof.py work_dirs/mv-3ddet/epoch_12.pth --launcher="pytorch"
 ```