ms-types 0.4.13 → 0.4.15

package/types/yolo.d.ts

@@ -1,114 +1,114 @@
-/**
- * YOLO目标检测模块 包含加载模型、目标检测等功能
- */
-declare namespace yolo {
-  /**
-   * YOLO检测结果
-   */
-  interface YoloResult {
-    /**
-     * 检测框的左上角x坐标
-     */
-    x: number;
-    /**
-     * 检测框的左上角y坐标
-     */
-    y: number;
-    /**
-     * 检测框的右下角x坐标
-     */
-    ex: number;
-    /**
-     * 检测框的右下角y坐标
-     */
-    ey: number;
-    /**
-     * 检测框的中心点x坐标
-     */
-    centerX: number;
-    /**
-     * 检测框的中心点y坐标
-     */
-    centerY: number;
-    /**
-     * 检测框的宽度
-     */
-    width: number;
-    /**
-     * 检测框的高度
-     */
-    height: number;
-    /**
-     * 检测框的置信度
-     */
-    confidence: number;
-    /**
-     * 检测框的类别ID
-     */
-    classId: number;
-  }
-  /**
-   * 加载YOLO模型
-   * @param paramPath ncnn模型的param文件的绝对路径
-   * @param binPath ncnn模型的bin文件绝对路径
-   * @param nc 模型的标签数量,可在标签集data.yaml中看到
-   * @param version 模型版本，默认11, 支持 8 11 26
-   * @returns 加载成功返回模型ID字符串，失败返回null
-   * @example
-   * const modelId = yolo.load("yolov8n.param", "yolov8n.bin", 80)
-   */
-  function load(
-    paramPath: string,
-    binPath: string,
-    nc: number,
-    version?: number
-  ): string | null;
-  /**
-   * 加载YOLOv11模型 （兼容 yolov8 模型）
-   * @param paramPath ncnn模型的param文件的绝对路径
-   * @param binPath ncnn模型的bin文件绝对路径
-   * @param nc 模型的标签数量,可在标签集data.yaml中看到
-   * @returns 加载成功返回模型ID字符串，失败返回null
-   * @example
-   * const modelId = yolo.loadV11("yolov11n.param", "yolov11n.bin", 80)
-   */
-  function loadV11(
-    paramPath: string,
-    binPath: string,
-    nc: number
-  ): string | null;
-
-  /**
-   * 目标检测
-   * @param modelId 模型ID
-   * @param img 图像ID，"screen"用当前屏幕检测，可以填入图像ID或者http图片地址或文件地址
-   * @param targetSize 图像进入后缩放的检测大小，模型训练一般都用640，因此这里的640一般不要改
-   * @param threshold 置信度，默认0.4，小于这个值的会被过滤掉
-   * @param nmsThreshold 重叠阈值，一般是0.5不需要更改
-   * @returns 检测结果数组
-   * @example
-   * const results = yolo.detect(modelId, "screen", 640, 0.4, 0.5)
-   */
-  function detect(
-    modelId: string,
-    img: string,
-    targetSize?: number,
-    threshold?: number,
-    nmsThreshold?: number
-  ): YoloResult[];
-
-  /**
-   * 释放指定模型资源
-   * @param modelId 模型ID
-   * @example
-   * yolo.free(modelId)
-   */
-  function free(modelId: string): void;
-
-  /**
-   * 释放所有模型资源
-   * @example
-   * yolo.freeAll()
-   */
-  function freeAll(): void;
-}
+/**
+ * YOLO目标检测模块 包含加载模型、目标检测等功能
+ */
+declare namespace yolo {
+  /**
+   * YOLO检测结果
+   */
+  interface YoloResult {
+    /**
+     * 检测框的左上角x坐标
+     */
+    x: number;
+    /**
+     * 检测框的左上角y坐标
+     */
+    y: number;
+    /**
+     * 检测框的右下角x坐标
+     */
+    ex: number;
+    /**
+     * 检测框的右下角y坐标
+     */
+    ey: number;
+    /**
+     * 检测框的中心点x坐标
+     */
+    centerX: number;
+    /**
+     * 检测框的中心点y坐标
+     */
+    centerY: number;
+    /**
+     * 检测框的宽度
+     */
+    width: number;
+    /**
+     * 检测框的高度
+     */
+    height: number;
+    /**
+     * 检测框的置信度
+     */
+    confidence: number;
+    /**
+     * 检测框的类别ID
+     */
+    classId: number;
+  }
+  /**
+   * 加载YOLO模型
+   * @param paramPath ncnn模型的param文件的绝对路径
+   * @param binPath ncnn模型的bin文件绝对路径
+   * @param nc 模型的标签数量,可在标签集data.yaml中看到
+   * @param version 模型版本，默认11, 支持 8 11 26
+   * @returns 加载成功返回模型ID字符串，失败返回null
+   * @example
+   * const modelId = yolo.load("yolov8n.param", "yolov8n.bin", 80)
+   */
+  function load(
+    paramPath: string,
+    binPath: string,
+    nc: number,
+    version?: number
+  ): string | null;
+  /**
+   * 加载YOLOv11模型 （兼容 yolov8 模型）
+   * @param paramPath ncnn模型的param文件的绝对路径
+   * @param binPath ncnn模型的bin文件绝对路径
+   * @param nc 模型的标签数量,可在标签集data.yaml中看到
+   * @returns 加载成功返回模型ID字符串，失败返回null
+   * @example
+   * const modelId = yolo.loadV11("yolov11n.param", "yolov11n.bin", 80)
+   */
+  function loadV11(
+    paramPath: string,
+    binPath: string,
+    nc: number
+  ): string | null;
+
+  /**
+   * 目标检测
+   * @param modelId 模型ID
+   * @param img 图像ID，"screen"用当前屏幕检测，可以填入图像ID或者http图片地址或文件地址
+   * @param targetSize 图像进入后缩放的检测大小，模型训练一般都用640，因此这里的640一般不要改
+   * @param threshold 置信度，默认0.4，小于这个值的会被过滤掉
+   * @param nmsThreshold 重叠阈值，一般是0.5不需要更改
+   * @returns 检测结果数组
+   * @example
+   * const results = yolo.detect(modelId, "screen", 640, 0.4, 0.5)
+   */
+  function detect(
+    modelId: string,
+    img: string,
+    targetSize?: number,
+    threshold?: number,
+    nmsThreshold?: number
+  ): YoloResult[];
+
+  /**
+   * 释放指定模型资源
+   * @param modelId 模型ID
+   * @example
+   * yolo.free(modelId)
+   */
+  function free(modelId: string): void;
+
+  /**
+   * 释放所有模型资源
+   * @example
+   * yolo.freeAll()
+   */
+  function freeAll(): void;
+}