docs: Add category help to Label (#5710)

Docs fix that adds help for the `category` field in Label tag. [`category` is used in the export](https://labelstud.io/guide/export.html#Question-3-How-to-modify-order-of-categories-for-COCO-and-YOLO-exports) (in label-studio-converter lib) to make order of classes for YOLO and COCO. --------- Co-authored-by: robot-ci-heartex <[email protected]> Co-authored-by: hlomzik <[email protected]>
HumanSignal · Apr 10, 2024 · acbea17 · acbea17
1 parent 8512d1e
commit acbea17
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 14 deletions.
diff --git a/docs/source/tags/label.md b/docs/source/tags/label.md
@@ -25,6 +25,7 @@ The `Label` tag represents a single label. Use with the `Labels` tag, including
 | [selectedColor] | <code>string</code> | <code>&quot;#ffffff&quot;</code> | Color of text in an active label in hexadecimal |
 | [granularity] | <code>symbol</code> \| <code>word</code> |  | Set control based on symbol or word selection (only for Text) |
 | [html] | <code>string</code> |  | HTML code is used to display label button instead of raw text provided by `value` (should be properly escaped) |
+| [category] | <code>int</code> |  | Category is used in the export (in label-studio-converter lib) to make an order of labels for YOLO and COCO |
 
 ### Example
 

diff --git a/web/dist/apps/labelstudio/version.json b/web/dist/apps/labelstudio/version.json
@@ -1,6 +1,6 @@
 {
-  "message": "Merge branch 'develop' into 'fb-leap-864'",
-  "commit": "1e75dadafb0544e19fcf5e2620f6880ee3afb668",
-  "date": "2024-04-10T13:19:35.000Z",
-  "branch": "fb-leap-864"
+  "message": "Update Label.js",
+  "commit": "bc97cdeb8a5a12c07f34fac9ad3e74118d5b343d",
+  "date": "2024-04-10T13:13:39.000Z",
+  "branch": "docs/category-help"
 }
diff --git a/web/dist/libs/datamanager/version.json b/web/dist/libs/datamanager/version.json
@@ -1,6 +1,6 @@
 {
-  "message": "Merge branch 'develop' into 'fb-leap-864'",
-  "commit": "1e75dadafb0544e19fcf5e2620f6880ee3afb668",
-  "date": "2024-04-10T13:19:35.000Z",
-  "branch": "fb-leap-864"
+  "message": "Update Label.js",
+  "commit": "bc97cdeb8a5a12c07f34fac9ad3e74118d5b343d",
+  "date": "2024-04-10T13:13:39.000Z",
+  "branch": "docs/category-help"
 }
diff --git a/web/dist/libs/editor/main.js b/web/dist/libs/editor/main.js
diff --git a/web/dist/libs/editor/main.js.map b/web/dist/libs/editor/main.js.map
diff --git a/web/dist/libs/editor/version.json b/web/dist/libs/editor/version.json
@@ -1,6 +1,6 @@
 {
-  "message": "Merge branch 'develop' into 'fb-leap-864'",
-  "commit": "1e75dadafb0544e19fcf5e2620f6880ee3afb668",
-  "date": "2024-04-10T13:19:35.000Z",
-  "branch": "fb-leap-864"
+  "message": "Update Label.js",
+  "commit": "bc97cdeb8a5a12c07f34fac9ad3e74118d5b343d",
+  "date": "2024-04-10T13:13:39.000Z",
+  "branch": "docs/category-help"
 }
diff --git a/web/libs/editor/src/tags/control/Label.js b/web/libs/editor/src/tags/control/Label.js
@@ -48,6 +48,7 @@ import { sanitizeHtml } from '../../utils/html';
  * @param {string} [selectedColor=#ffffff]  - Color of text in an active label in hexadecimal
  * @param {symbol|word} [granularity]       - Set control based on symbol or word selection (only for Text)
  * @param {string} [html]                   - HTML code is used to display label button instead of raw text provided by `value` (should be properly escaped)
+ * @param {int} [category]                  - Category is used in the export (in label-studio-converter lib) to make an order of labels for YOLO and COCO
  */
 const TagAttrs = types.model({
   value: types.maybeNull(types.string),