From 0c72b1b274c4511c84bc788d969e9fb9fbf7f03f Mon Sep 17 00:00:00 2001
From: Haodong Duan <34324155+kennymckormick@users.noreply.github.com>
Date: Tue, 1 Jun 2021 12:15:03 +0800
Subject: [PATCH] update docstring of run.py (#28)

---
 mim/commands/run.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/mim/commands/run.py b/mim/commands/run.py
index 3f1f9ca..1adbd2d 100644
--- a/mim/commands/run.py
+++ b/mim/commands/run.py
@@ -28,6 +28,11 @@ from mim.utils import (
 def cli(package: str, command: str, other_args: tuple = ()) -> None:
     """Run arbitrary command of a codebase.
 
+    Note if the command you call takes config files or checkpoint paths as
+    arguments, you must use paths that do exists. We do not accept URLs or
+    config names (like resnet101_b16x8_cifar10.py) if that doesn't exist under
+    your current directory.
+
     Example:
 
     \b