Bladeren bron

update mlclas module doc (#2935)

changdazhou 10 maanden geleden
bovenliggende
commit
c012a930ae
1 gewijzigde bestanden met toevoegingen van 26 en 2 verwijderingen
  1. 26 2
      docs/module_usage/tutorials/cv_modules/image_multilabel_classification.md

+ 26 - 2
docs/module_usage/tutorials/cv_modules/image_multilabel_classification.md

@@ -84,7 +84,7 @@ for res in output:
 
 可视化图片如下:
 
-<img src="https://github.com/user-attachments/assets/4bdd6999-637d-4c9b-aa47-8dd6f587f5a1">
+<img src="https://raw.githubusercontent.com/cuicheng01/PaddleX_doc_images/refs/heads/main/images/modules/image_multilabel_classification/multilabel_classification_005_result.png">
 
 相关方法、参数等说明如下:
 
@@ -113,11 +113,24 @@ for res in output:
 <td>无</td>
 <td>无</td>
 </tr>
+<tr>
+<td><code>threshold</code></td>
+<td>多标签分类阈值</td>
+<td><code>float/list/dict</code></td>
+<td><li><b>float类型变量</b>,任意[0-1]之间浮点数:<code>0.5</code></li>
+<li><b>list类型变量</b>,由多个[0-1]之间浮点数组成的列表:<code>[0.5,0.5,...]</code></li>
+<li><b>dict类型变量</b>,指定不同类别使用不同的阈值,其中"default"为必须包含的键:<code>{"default":0.5,1:0.1,...}</code>
+</li>
+</td>
+<td>0.5</td>
+</tr>
 </table>
 
 * 其中,`model_name` 必须指定,指定 `model_name` 后,默认使用 PaddleX 内置的模型参数,在此基础上,指定 `model_dir` 时,使用用户自定义的模型。
 
-* 调用文本识别模型的 `predict()` 方法进行推理预测,`predict()` 方法参数有 `input` 和 `batch_size`,具体说明如下:
+* 其中,`threshold` 参数用于设置多标签分类的阈值,默认为0.5。当设置为浮点数时,表示所有类别均使用该阈值;当设置为列表时,表示不同类别使用不同的阈值,此时需保持列表长度与类别数量一致;当设置为字典时,`default` 为必须包含的键, 表示所有类别的默认阈值,其它类别使用各自的阈值。例如:{"default":0.5,1:0.1}。
+
+* 调用多标签分类模型的 `predict()` 方法进行推理预测,`predict()` 方法参数有 `input` , `batch_size` 和  `threshold`,具体说明如下:
 
 <table>
 <thead>
@@ -152,6 +165,17 @@ for res in output:
 <td>任意整数</td>
 <td>1</td>
 </tr>
+<tr>
+<td><code>threshold</code></td>
+<td>多标签分类阈值</td>
+<td><code>float/list/dict</code></td>
+<td><li><b>float类型变量</b>,任意[0-1]之间浮点数:<code>0.5</code></li>
+<li><b>list类型变量</b>,由多个[0-1]之间浮点数组成的列表:<code>[0.5,0.5,...]</code></li>
+<li><b>dict类型变量</b>,指定不同类别使用不同的阈值,其中"default"为必须包含的键:<code>{"default":0.5,1:0.1,...}</code>
+</li>
+</td>
+<td>0.5</td>
+</tr>
 </table>
 
 * 对预测结果进行处理,每个样本的预测结果均为`dict`类型,且支持打印、保存为图片、保存为`json`文件的操作: