docs: Fix tags in gitignore; add missed tags (HumanSignal#2650)

* docs: Fix tags in gitignore; add missed tags Brush, Collapse and Repeater tags missed from docs. * Capitalize some descriptions * Also update Shortcut tag from tag jsdoc * docs: add new DateTime, reorder control tags * docs: Brush is not new, just missed previously * 24 hour
mihow · Jul 15, 2022 · 42566fb · 42566fb
1 parent 46f6619
commit 42566fb
Show file tree

Hide file tree

Showing 30 changed files with 183 additions and 32 deletions.
diff --git a/.gitignore b/.gitignore
@@ -48,7 +48,6 @@ archive
 *.idea/*
 .vscode/*
 pyrightconfig.json
-tags
 tags.temp
 mydatabase
 label_studio.sqlite3

diff --git a/docs/source/tags/brush.md b/docs/source/tags/brush.md
@@ -0,0 +1,60 @@
+---
+title: Brush
+type: tags
+order: 401
+meta_title: Brush Tag for Image Segmentation Labeling
+meta_description: Customize Label Studio with brush tags for image segmentation labeling for machine learning and data science projects.
+---
+
+Use the Brush tag for image segmentation tasks where you want to apply a mask or use a brush to draw a region on the image.
+
+Use with the following data types: image
+
+### Parameters
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| name | <code>string</code> |  | Name of the element |
+| toName | <code>string</code> |  | Name of the image to label |
+| [choice] | <code>single</code> \| <code>multiple</code> | <code>single</code> | Configure whether the data labeler can select one or multiple labels |
+| [maxUsages] | <code>number</code> |  | Maximum number of times a label can be used per task |
+| [showInline] | <code>boolean</code> | <code>true</code> | Show labels in the same visual line |
+| [smart] | <code>boolean</code> |  | Show smart tool for interactive pre-annotations |
+| [smartOnly] | <code>boolean</code> |  | Only show smart tool for interactive pre-annotations |
+
+### Sample Results JSON
+
+| Name | Type | Description |
+| --- | --- | --- |
+| original_width | <code>number</code> | Width of the original image (px) |
+| original_height | <code>number</code> | Height of the original image (px) |
+| image_rotation | <code>number</code> | Rotation degree of the image (deg) |
+| value | <code>Object</code> |  |
+| value.format | <code>&quot;rle&quot;</code> | Format of the masks, only RLE is supported for now |
+| value.rle | <code>Array.&lt;number&gt;</code> | RLE-encoded image |
+
+### Example JSON
+```json
+{
+  "original_width": 1920,
+  "original_height": 1280,
+  "image_rotation": 0,
+  "value": {
+    "format": "rle",
+    "rle": [0, 1, 1, 2, 3],
+    "brushlabels": ["Car"]
+  }
+}
+```
+
+### Example
+```html
+<!--Basic image segmentation labeling configuration-->
+<View>
+  <Brush name="labels" toName="image">
+    <Label value="Person" />
+    <Label value="Animal" />
+  </Brush>
+  <Image name="image" value="$image" />
+</View>
+```
diff --git a/docs/source/tags/brushlabels.md b/docs/source/tags/brushlabels.md
@@ -24,11 +24,11 @@ Use with the following data types: image
 
 | Name | Type | Description |
 | --- | --- | --- |
-| original_width | <code>number</code> | width of the original image (px) |
-| original_height | <code>number</code> | height of the original image (px) |
-| image_rotation | <code>number</code> | rotation degree of the image (deg) |
+| original_width | <code>number</code> | Width of the original image (px) |
+| original_height | <code>number</code> | Height of the original image (px) |
+| image_rotation | <code>number</code> | Rotation degree of the image (deg) |
 | value | <code>Object</code> |  |
-| value.format | <code>&quot;rle&quot;</code> | format of the masks, only RLE is supported for now |
+| value.format | <code>&quot;rle&quot;</code> | Format of the masks, only RLE is supported for now |
 | value.rle | <code>Array.&lt;number&gt;</code> | RLE-encoded image |
 
 ### Example JSON

diff --git a/docs/source/tags/collapse.md b/docs/source/tags/collapse.md
@@ -0,0 +1,24 @@
+---
+title: Collapse
+type: tags
+order: 501
+is_new: t
+---
+
+Collapse tag, a content area which can be collapsed and expanded.
+
+### Parameters
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [accordion] | <code>boolean</code> | <code>true</code> | Works as an accordion |
+| [bordered] | <code>string</code> | <code>false</code> | Shows border |
+
+### Example
+```html
+<Collapse>
+  <Panel value="Panel Header">
+    <View><Header value="Hello world" /></View>
+  </Panel>
+</Collapse>
+```
diff --git a/docs/source/tags/datetime.md b/docs/source/tags/datetime.md
@@ -0,0 +1,32 @@
+---
+title: DateTime
+type: tags
+order: 405
+is_new: t
+---
+
+The DateTime tag adds date and time selection to the labeling interface. Use this tag to add a date, timestamp, month, or year to an annotation.
+
+Use with the following data types: audio, image, HTML, paragraph, text, time series, video
+
+### Parameters
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| name | <code>string</code> |  | Name of the element |
+| toName | <code>string</code> |  | Name of the element that you want to label |
+| only | <code>string</code> |  | Comma-separated list of parts to display (date, time, month, year)        date and month/year can't be used together. The date option takes precedence |
+| format | <code>string</code> |  | Input/output strftime format for datetime (internally it's always ISO);        when both date and time are displayed, by default shows ISO with a "T" separator;        when only date is displayed, by default shows ISO date;        when only time is displayed, by default shows a 24 hour time with leading zero |
+| [min] | <code>string</code> |  | Set a minimum datetime value for only=date, minimum year for only=year |
+| [max] | <code>string</code> |  | Set a maximum datetime value for only=date, maximum year for only=year |
+| [required] | <code>boolean</code> | <code>false</code> | Whether datetime is required or not |
+| [requiredMessage] | <code>string</code> |  | Message to show if validation fails |
+| [perRegion] | <code>boolean</code> |  | Use this option to label regions instead of the whole object |
+
+### Example
+```html
+<View>
+  <Text name="txt" value="$text" />
+  <DateTime name="datetime" toName="txt" only="date" />
+</View>
+```
diff --git a/docs/source/tags/ellipse.md b/docs/source/tags/ellipse.md
@@ -1,7 +1,7 @@
 ---
 title: Ellipse
 type: tags
-order: 405
+order: 406
 meta_title: Ellipse Tag for Adding Elliptical Bounding Box to Images
 meta_description: Customize Label Studio with ellipse tags to add elliptical bounding boxes to images for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/ellipselabels.md b/docs/source/tags/ellipselabels.md
@@ -1,7 +1,7 @@
 ---
 title: EllipseLabels
 type: tags
-order: 406
+order: 407
 meta_title: Ellipse Label Tag for Labeling Images with Elliptical Bounding Boxes
 meta_description: Customize Label Studio with the EllipseLabels tag to label images with elliptical bounding boxes for semantic image segmentation machine learning and data science projects.
 ---

diff --git a/docs/source/tags/hypertextlabels.md b/docs/source/tags/hypertextlabels.md
@@ -1,7 +1,7 @@
 ---
 title: HyperTextLabels
 type: tags
-order: 407
+order: 408
 meta_title: Hypertext Label Tag to Create Labeled Hypertext (HTML)
 meta_description: Customize Label Studio with the HyperTextLabels tag to label hypertext (HTML) for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/image.md b/docs/source/tags/image.md
@@ -18,6 +18,7 @@ When you annotate image regions with this tag, the annotations are saved as perc
 | --- | --- | --- | --- |
 | name | <code>string</code> |  | Name of the element |
 | value | <code>string</code> |  | Data field containing a path or URL to the image |
+| [smoothing] | <code>boolean</code> |  | Enable smoothing, by default it uses user settings |
 | [width] | <code>string</code> | <code>&quot;100%&quot;</code> | Image width |
 | [maxWidth] | <code>string</code> | <code>&quot;750px&quot;</code> | Maximum image width |
 | [zoom] | <code>boolean</code> | <code>false</code> | Enable zooming an image with the mouse wheel |

diff --git a/docs/source/tags/keypoint.md b/docs/source/tags/keypoint.md
@@ -1,7 +1,7 @@
 ---
 title: KeyPoint
 type: tags
-order: 408
+order: 409
 meta_title: Keypoint Tag for Adding Keypoints to Images
 meta_description: Customize Label Studio with the KeyPoint tag to add key points to images for computer vision machine learning and data science projects.
 ---

diff --git a/docs/source/tags/keypointlabels.md b/docs/source/tags/keypointlabels.md
@@ -1,7 +1,7 @@
 ---
 title: KeyPointLabels
 type: tags
-order: 409
+order: 410
 meta_title: Keypoint Label Tag for Labeling Keypoints
 meta_description: Customize Label Studio with the KeyPointLabels tag to label keypoints for computer vision machine learning and data science projects.
 ---

diff --git a/docs/source/tags/label.md b/docs/source/tags/label.md
@@ -1,7 +1,7 @@
 ---
 title: Label
 type: tags
-order: 410
+order: 411
 meta_title: Label Tag for Single Label Tags
 meta_description: Customize Label Studio with the Label tag to assign a single label to regions in a task for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/labels.md b/docs/source/tags/labels.md
@@ -1,7 +1,7 @@
 ---
 title: Labels
 type: tags
-order: 411
+order: 412
 meta_title: Labels Tag for Labeling Regions
 meta_description: Customize Label Studio by using the Labels tag to provide a set of labels for labeling regions in tasks for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/list.md b/docs/source/tags/list.md
@@ -1,7 +1,7 @@
 ---
 title: List
 type: tags
-order: 412
+order: 413
 meta_title: List Tag for Lists
 meta_description: Customize Label Studio with lists for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/number.md b/docs/source/tags/number.md
@@ -1,7 +1,7 @@
 ---
 title: Number
 type: tags
-order: 413
+order: 414
 meta_title: Number Tag to Numerically Classify
 meta_description: Customize Label Studio with the Number tag to numerically classify tasks in your machine learning and data science projects.
 ---

diff --git a/docs/source/tags/pairwise.md b/docs/source/tags/pairwise.md
@@ -1,7 +1,7 @@
 ---
 title: Pairwise
 type: tags
-order: 414
+order: 415
 meta_title: Pairwise Tag to Compare Objects
 meta_description: Customize Label Studio with the Pairwise tag for object comparison tasks for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/paragraphlabels.md b/docs/source/tags/paragraphlabels.md
@@ -1,7 +1,7 @@
 ---
 title: ParagraphLabels
 type: tags
-order: 415
+order: 416
 meta_title: Paragraph Label Tag for Paragraph Labels
 meta_description: Customize Label Studio with paragraph labels for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/polygon.md b/docs/source/tags/polygon.md
@@ -1,7 +1,7 @@
 ---
 title: Polygon
 type: tags
-order: 416
+order: 417
 meta_title: Polygon Tag for Adding Polygons to Images
 meta_description: Customize Label Studio with the Polygon tag by adding polygons to images for segmentation machine learning and data science projects.
 ---

diff --git a/docs/source/tags/polygonlabels.md b/docs/source/tags/polygonlabels.md
@@ -1,7 +1,7 @@
 ---
 title: PolygonLabels
 type: tags
-order: 417
+order: 418
 meta_title: Polygon Label Tag for Labeling Polygons in Images
 meta_description: Customize Label Studio with the PolygonLabels tag and label polygons in images for semantic segmentation machine learning and data science projects.
 ---

diff --git a/docs/source/tags/ranker.md b/docs/source/tags/ranker.md
@@ -1,7 +1,7 @@
 ---
 title: Ranker
 type: tags
-order: 418
+order: 419
 meta_title: Ranker Tag for Model Ranking
 meta_description: Customize Label Studio with the Ranker tag to rank the predictions from different models to rank model quality in your machine learning and data science projects.
 ---

diff --git a/docs/source/tags/rating.md b/docs/source/tags/rating.md
@@ -1,7 +1,7 @@
 ---
 title: Rating
 type: tags
-order: 419
+order: 420
 meta_title: Rating Tag for Ratings
 meta_description: Customize Label Studio to add ratings to tasks with the Rating tag in your machine learning and data science projects.
 ---

diff --git a/docs/source/tags/rectangle.md b/docs/source/tags/rectangle.md
@@ -1,7 +1,7 @@
 ---
 title: Rectangle
 type: tags
-order: 420
+order: 421
 meta_title: Rectangle Tag for Adding Rectangle Bounding Box to Images
 meta_description: Customize Label Studio with the Rectangle tag to add rectangle bounding boxes to images for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/rectanglelabels.md b/docs/source/tags/rectanglelabels.md
@@ -1,7 +1,7 @@
 ---
 title: RectangleLabels
 type: tags
-order: 421
+order: 422
 meta_title: Rectangle Label Tag to Label Rectangle Bounding Box in Images
 meta_description: Customize Label Studio with the RectangleLabels tag and add labeled rectangle bounding boxes in images for semantic segmentation and object detection machine learning and data science projects.
 ---

diff --git a/docs/source/tags/relation.md b/docs/source/tags/relation.md
@@ -1,7 +1,7 @@
 ---
 title: Relation
 type: tags
-order: 422
+order: 423
 meta_title: Relation Tag for a Single Relation
 meta_description: Customize Label Studio by using the Relation tag to add a single consistent label to relations between regions in machine learning and data science projects.
 ---

diff --git a/docs/source/tags/relations.md b/docs/source/tags/relations.md
@@ -1,7 +1,7 @@
 ---
 title: Relations
 type: tags
-order: 423
+order: 424
 meta_title: Relations Tag for Multiple Relations
 meta_description: Customize Label Studio by adding labels to relationships between labeled regions for machine learning and data science projects.
 ---

diff --git a/docs/source/tags/repeater.md b/docs/source/tags/repeater.md
@@ -0,0 +1,31 @@
+---
+title: Repeater
+type: tags
+order: 504
+is_new: t
+meta_title: Repeater Tag to duplicate annotation settings
+meta_description: Customize Label Studio with the Repeater tag to repeat similar data blocks to accelerate labeling for machine learning and data science projects.
+---
+
+Repeater Tag for annotating multiple data objects in a dynamic range with the same semantics. You can loop through data items in a python-like for cycle in the labeling process.
+It repeats tags inside it for every item in a given data array from your dataset. Supports all tags except Labels.
+
+### Parameters
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| on | <code>string</code> |  | Data field object with array with similar data |
+| [indexFlag] | <code>string</code> | <code>&quot;{{idx}}&quot;</code> | Placeholder for array index in params of underlying tags |
+
+### Example
+```html
+<Repeater on="$utterances" indexFlag="{{idx}}">
+  <Text name="user_{{idx}}" value="$utterances[{{idx}}].text"/>
+  <Header value="Utterance Review"/>
+  <Choices name="utterance_action_{{idx}}" showInline="true" toName="user_{{idx}}">
+    <Choice value="No Action"/>
+    <Choice value="Training"/>
+    <Choice value="New Intent"/>
+  </Choices>
+</Repeater>
+```
diff --git a/docs/source/tags/shortcut.md b/docs/source/tags/shortcut.md
@@ -1,14 +1,14 @@
 ---
 title: Shortcut
 type: tags
-order: 424
+order: 425
 meta_title: Shortcut Tag to Define Shortcuts
 meta_description: Customize Label Studio to define keyboard shortcuts and hotkeys to accelerate labeling for machine learning and data science projects.
 ---
 
 Use the Shortcut tag to define a shortcut that annotators can use to add a predefined object, such as a specific label value, with a hotkey or keyboard shortcut.
 
-Use with the following data types: 
+Use with the following data types:
 - Audio
 - Image
 - HTML
@@ -26,11 +26,15 @@ Use with the following data types:
 | [hotkey] | <code>string</code> |  | Hotkey |
 | [background] | <code>string</code> | <code>&quot;#333333&quot;</code> | Background color in hexadecimal |
 
-> Note: The default background color for the Shortcut tag is grey color. You can change the background color using text or hexadecimal format in the `[background]` parameter.
-
 ### Example
 ```html
-<!--Basic labeling configuration to add a shortcut that places the text SILENCE in a given Text Area while doing transcription -->
+<!--
+Basic labeling configuration to add a shortcut that places the text SILENCE in a given Text Area while doing transcription.
+
+Note: The default background color for the Shortcut tag is grey color.
+
+You can change the background color using text or hexadecimal format in the `background` parameter.
+-->
 <View>
   <TextArea name="txt-1">
     <Shortcut alias="Silence" value="SILENCE" hotkey="ctrl+1" background="#3333333" />

diff --git a/docs/source/tags/taxonomy.md b/docs/source/tags/taxonomy.md
@@ -1,7 +1,7 @@
 ---
 title: Taxonomy
 type: tags
-order: 425
+order: 426
 meta_title: Taxonomy Tag for Hierarchical Labels
 meta_description: Customize Label Studio with the Taxonomy tag and use hierarchical labels for machine learning and data science projects.
 ---