polish docstring

open-mmlab · Jul 26, 2020 · 4191f26 · 4191f26
1 parent a9a9d9b
commit 4191f26
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/mmaction/apis/inference.py b/mmaction/apis/inference.py
@@ -57,7 +57,9 @@ def inference_recognizer(model, video_path, label_path, use_frames=False):
 
     Args:
         model (nn.Module): The loaded recognizer.
-        video_path (str): The video file path or the rawframes path.
+        video_path (str): The video file path or the rawframes directory path.
+            If ``use_frames`` is set to True, it should be rawframes directory
+            path. Otherwise, it should be video file path.
         label_path (str): The label file path.
         use_frames (bool): Whether to use rawframes as input. Default:False.