Merge pull request #313 from LiMuhua/main

[doc] Optimize the description of the parameters

anylabeling/app.py

@@ -38,7 +38,12 @@ def main():
         choices=["debug", "info", "warning", "fatal", "error"],
         help="logger level",
     )
-    parser.add_argument("filename", nargs="?", help="image or label filename")
+    parser.add_argument(
+        "filename",
+        nargs="?",
+        help=(
+            "image or label filename; "
+            "If a directory path is passed in, the folder will be loaded automatically"))
     parser.add_argument(
         "--output",
         "-O",

docs/en/get_started.md

@@ -19,7 +19,7 @@ To ensure access to the latest features and stable performance, it is highly rec
      ```bash
      # upgrade pip to its latest version
      pip install -U pip
-
+     
      pip install -r requirements-dev.txt
      ```
 
@@ -53,6 +53,35 @@ Note:
 
 If you need to save to a different directory, you can click on the top-left `File` -> `Save As`, and then choose the destination directory for saving.
 
+### Operating Parameter
+
+Location parameters.
+
+* filename: image or label filename; if a directory path is passed in, the folder will be automatically loaded
+
+
+
+Options/Keywords parameters: 
+
+* `--help`,`-h`: display help message and exit.
+
+- `--reset-config`: Reset the Qt configuration, clearing all settings.
+- `--logger-level`: Set the logging level, options include "debug", "info", "warning", "fatal", "error".
+- `--output`, `-O`, `-o`: Specify the output file or directory. If it ends in `.json`, it is recognized as a file, otherwise it is recognized as a directory.
+- `--config`: Specify a configuration file or a string providing configuration information in YAML format.
+  Defaults to `~/.anylabelingrc` (Linux)         `C:\Users\{user}\.anylabelingrc` (Windows).
+- `--nodata`: Stops storing image data in JSON files.
+- `--autosave`: Automatically saves annotation data.
+- `--nosortlabels`: Stop sorting labels.
+- `--flags`: Comma-separated list of flags or file containing flags.
+- `--labelflags`: A YAML string containing label-specific flags or a file containing a JSON string.
+- `--labels`: Comma-separated list of labels or file containing labels.
+- `--validatelabel`: Label validation type.
+- `--keep-prev`: Keep comments from previous frame.
+- `--epsilon`: Find the epsilon of the nearest vertex on the canvas.
+
+
+
 ### Quick Annotation
 
 The tool supports various annotation styles (Polygon, Rectangle, Rotated Box, Circle, Line, Linestrip, Point). Use shortcut keys (e.g., P for Polygon, R for Rectangle, O for Rotation) for quick drawing.

docs/zh_cn/get_started.md

@@ -69,6 +69,31 @@ python anylabeling/app.py
 
 需要注意的是，默认的标注文件保存路径为导入文件路径，如果需要存放到其它目录，可点击左上角 `文件` -> `另存为`，选择保存目录即可。
 
+### 运行参数
+
+位置参数:
+
+* filename: 图像或标签文件名;如果传入目录路径，则会自动加载该文件夹
+
+选项/关键字参数:
+
+* `--help`,`-h`: 显示帮助消息并退出
+
+- `--reset-config`: 重置 Qt 配置，清除所有设置。
+- `--logger-level`: 设置日志级别，可选值包括 "debug", "info", "warning", "fatal", "error"。
+- `--output`, `-O`, `-o`: 指定输出文件或目录。如果以 `.json` 结尾，则被识别为文件，否则被识别为目录。
+- `--config`: 指定配置文件或者以 YAML 格式提供配置信息的字符串
+  默认为 `~/.anylabelingrc`(Linux)      `C:\Users\{user}\.anylabelingrc`(Windows)。
+- `--nodata`: 停止将图像数据存储到 JSON 文件中。
+- `--autosave`: 自动保存标注数据。
+- `--nosortlabels`: 停止对标签进行排序。
+- `--flags`: 逗号分隔的标志列表或包含标志的文件。
+- `--labelflags`: 包含标签特定标志的 YAML 字符串或包含 JSON 字符串的文件。
+- `--labels`: 逗号分隔的标签列表或包含标签的文件。
+- `--validatelabel`: 标签验证类型。
+- `--keep-prev`: 保留前一帧的注释。
+- `--epsilon`: 在画布上找到最近顶点的 epsilon。
+
 ### 快速绘制
 
 当前 `X-AnyLabeling` 中支持**多边形**、**矩形框**、**旋转框**、**圆形**、**线段**、**多线段**和**点**等多种标注样式，可供用户灵活地选取。部分绘制模式的快捷键设置如下：