Skip to content

Commit 7460ebf

Browse files
robot-ci-heartexrobot-ci-heartex
committed
ci: Build tag docs
Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/15112933931
1 parent 287dd5a commit 7460ebf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+914
-0
lines changed

‎docs/includes/tags/audio.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| name | <code>string</code> | | Name of the element |
6+
| value | <code>string</code> | | Data field containing path or a URL to the audio. |
7+
| [defaultspeed] | <code>string</code> | <code>1</code> | Default speed level (from 0.5 to 2). |
8+
| [defaultscale] | <code>string</code> | <code>1</code> | Audio pane default y-scale for waveform. |
9+
| [defaultzoom] | <code>string</code> | <code>1</code> | Default zoom level for waveform. (from 1 to 1500). |
10+
| [defaultvolume] | <code>string</code> | <code>1</code> | Default volume level (from 0 to 1). |
11+
| [hotkey] | <code>string</code> | | Hotkey used to play or pause audio. |
12+
| [sync] | <code>string</code> | | Object name to sync with. |
13+
| [height] | <code>string</code> | <code>96</code> | Total height of the audio player. |
14+
| [waveheight] | <code>string</code> | <code>32</code> | Minimum height of a waveform when in `splitchannels` mode with multiple channels to display. |
15+
| [splitchannels] | <code>boolean</code> | <code>false</code> | Display multiple audio channels separately, if the audio file has more than one channel. (**NOTE: Requires more memory to operate.**) |
16+
| [decoder] | <code>string</code> | <code>&quot;webaudio&quot;</code> | Decoder type to use to decode audio data. (`"webaudio"` or `"ffmpeg"`) |
17+
| [player] | <code>string</code> | <code>&quot;html5&quot;</code> | Player type to use to play audio data. (`"html5"` or `"webaudio"`) |
18+
19+
### Sample Results JSON
20+
21+
| Name | Type | Description |
22+
| --- | --- | --- |
23+
| original_length | <code>number</code> | length of the original audio (seconds) |
24+
| value | <code>Object</code> | |
25+
| value.start | <code>number</code> | start time of the fragment (seconds) |
26+
| value.end | <code>number</code> | end time of the fragment (seconds) |
27+
| value.channel | <code>number</code> | channel identifier which was targeted |
28+
29+
### Example JSON
30+
```json
31+
{
32+
"original_length": 18,
33+
"value": {
34+
"start": 3.1,
35+
"end": 8.2,
36+
"channel": 0,
37+
"labels": ["Voice"]
38+
}
39+
}
40+
```
41+

‎docs/includes/tags/brush.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| name | <code>string</code> | | Name of the element |
6+
| toName | <code>string</code> | | Name of the image to label |
7+
| [choice] | <code>single</code> \| <code>multiple</code> | <code>single</code> | Configure whether the data labeler can select one or multiple labels |
8+
| [maxUsages] | <code>number</code> | | Maximum number of times a label can be used per task |
9+
| [showInline] | <code>boolean</code> | <code>true</code> | Show labels in the same visual line |
10+
| [smart] | <code>boolean</code> | | Show smart tool for interactive pre-annotations |
11+
| [smartOnly] | <code>boolean</code> | | Only show smart tool for interactive pre-annotations |
12+
13+
### Sample Results JSON
14+
15+
| Name | Type | Description |
16+
| --- | --- | --- |
17+
| original_width | <code>number</code> | Width of the original image (px) |
18+
| original_height | <code>number</code> | Height of the original image (px) |
19+
| image_rotation | <code>number</code> | Rotation degree of the image (deg) |
20+
| value | <code>Object</code> | |
21+
| value.format | <code>&quot;rle&quot;</code> | Format of the masks, only RLE is supported for now |
22+
| value.rle | <code>Array.&lt;number&gt;</code> | RLE-encoded image |
23+
24+
### Example JSON
25+
```json
26+
{
27+
"original_width": 1920,
28+
"original_height": 1280,
29+
"image_rotation": 0,
30+
"value": {
31+
"format": "rle",
32+
"rle": [0, 1, 1, 2, 3],
33+
"brushlabels": ["Car"]
34+
}
35+
}
36+
```
37+

‎docs/includes/tags/brushlabels.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| name | <code>string</code> | | Name of the element |
6+
| toName | <code>string</code> | | Name of the image to label |
7+
| [choice] | <code>single</code> \| <code>multiple</code> | <code>single</code> | Configure whether the data labeler can select one or multiple labels |
8+
| [maxUsages] | <code>number</code> | | Maximum number of times a label can be used per task |
9+
| [showInline] | <code>boolean</code> | <code>true</code> | Show labels in the same visual line |
10+
11+
### Sample Results JSON
12+
13+
| Name | Type | Description |
14+
| --- | --- | --- |
15+
| original_width | <code>number</code> | Width of the original image (px) |
16+
| original_height | <code>number</code> | Height of the original image (px) |
17+
| image_rotation | <code>number</code> | Rotation degree of the image (deg) |
18+
| value | <code>Object</code> | |
19+
| value.format | <code>&quot;rle&quot;</code> | Format of the masks, only RLE is supported for now |
20+
| value.rle | <code>Array.&lt;number&gt;</code> | RLE-encoded image |
21+
22+
### Example JSON
23+
```json
24+
{
25+
"original_width": 1920,
26+
"original_height": 1280,
27+
"image_rotation": 0,
28+
"value": {
29+
"format": "rle",
30+
"rle": [0, 1, 1, 2, 3],
31+
"brushlabels": ["Car"]
32+
}
33+
}
34+
```
35+

‎docs/includes/tags/bucket.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
### Parameters
2+
3+
| Param | Type | Description |
4+
| --- | --- | --- |
5+
| name | <code>string</code> | Name of the column; used as a key in resulting data |
6+
| title | <code>string</code> | Title of the column |
7+
| [default] | <code>boolean</code> | This Bucket will be used to display results from `List` by default; see `Ranker` tag for more details |
8+

‎docs/includes/tags/channel.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| column | <code>string</code> | | column name or index |
6+
| [legend] | <code>string</code> | | display name of the channel |
7+
| [units] | <code>string</code> | | display units name |
8+
| [displayFormat] | <code>string</code> | | format string for the values, uses d3-format:<br/> `[,][.precision][f\|%]`<br/> `,` - group thousands with separator (from locale): `,` (12345.6 -> 12,345.6) `,.2f` (12345.6 -> 12,345.60)<br/> `.precision` - precision for `f\|%` type, significant digits for empty type:<br/> `.3f` (12.3456 -> 12.345, 1000 -> 1000.000)<br/> `.3` (12.3456 -> 12.3, 1.2345 -> 1.23, 12345 -> 1.23e+4)<br/> `f` - treat as float, default precision is .6: `f` (12 -> 12.000000) `.2f` (12 -> 12.00) `.0f` (12.34 -> 12)<br/> `%` - treat as percents and format accordingly: `%.0` (0.128 -> 13%) `%.1` (1.2345 -> 123.4%) |
9+
| [height] | <code>number</code> | | height of the plot |
10+
| [strokeColor] | <code>string</code> | <code>&quot;#f48a42&quot;</code> | plot stroke color, expects hex value |
11+
| [strokeWidth] | <code>number</code> | <code>1</code> | plot stroke width |
12+
| [markerColor] | <code>string</code> | <code>&quot;#f48a42&quot;</code> | plot stroke color, expects hex value |
13+
| [markerSize] | <code>number</code> | <code>0</code> | plot stroke width |
14+
| [markerSymbol] | <code>number</code> | <code>circle</code> | plot stroke width |
15+
| [timeRange] | <code>string</code> | | data range of x-axis / time axis |
16+
| [dataRange] | <code>string</code> | | data range of y-axis / data axis |
17+
| [showAxis] | <code>string</code> | | show or bide both axis |
18+
| [fixedScale] | <code>boolean</code> | | if false current view scales to fit only displayed values; if given overwrites TimeSeries' fixedScale |
19+

‎docs/includes/tags/choice.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### Parameters
2+
3+
| Param | Type | Description |
4+
| --- | --- | --- |
5+
| value | <code>string</code> | Choice value |
6+
| [selected] | <code>boolean</code> | Specify whether to preselect this choice on the labeling interface |
7+
| [alias] | <code>string</code> | Alias for the choice. If used, the alias replaces the choice value in the annotation results. Alias does not display in the interface. |
8+
| [style] | <code>style</code> | CSS style of the checkbox element |
9+
| [hotkey] | <code>string</code> | Hotkey for the selection |
10+
| [html] | <code>string</code> | Can be used to show enriched content, it has higher priority than `value`, however `value` will be used in the exported result (should be properly escaped) |
11+
| [hint] | <code>string</code> | Hint for choice on hover |
12+
| [color] | <code>string</code> | Color for Taxonomy item |
13+

‎docs/includes/tags/choices.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| name | <code>string</code> | | Name of the group of choices |
6+
| toName | <code>string</code> | | Name of the data item that you want to label |
7+
| [choice] | <code>single</code> \| <code>single-radio</code> \| <code>multiple</code> | <code>single</code> | Single or multi-class classification |
8+
| [showInline] | <code>boolean</code> | <code>false</code> | Show choices in the same visual line |
9+
| [required] | <code>boolean</code> | <code>false</code> | Validate whether a choice has been selected |
10+
| [requiredMessage] | <code>string</code> | | Show a message if validation fails |
11+
| [visibleWhen] | <code>region-selected</code> \| <code>no-region-selected</code> \| <code>choice-selected</code> \| <code>choice-unselected</code> | | Control visibility of the choices. Can also be used with the `when*` parameters below to narrow down visibility |
12+
| [whenTagName] | <code>string</code> | | Use with `visibleWhen`. Narrow down visibility by name of the tag. For regions, use the name of the object tag, for choices, use the name of the `choices` tag |
13+
| [whenLabelValue] | <code>string</code> | | Use with `visibleWhen="region-selected"`. Narrow down visibility by label value. Multiple values can be separated with commas |
14+
| [whenChoiceValue] | <code>string</code> | | Use with `visibleWhen` (`"choice-selected"` or `"choice-unselected"`) and `whenTagName`, both are required. Narrow down visibility by choice value. Multiple values can be separated with commas |
15+
| [perRegion] | <code>boolean</code> | | Use this tag to select a choice for a specific region instead of the entire task |
16+
| [perItem] | <code>boolean</code> | | Use this tag to select a choice for a specific item inside the object instead of the whole object |
17+
| [value] | <code>string</code> | | Task data field containing a list of dynamically loaded choices (see example below) |
18+
| [allowNested] | <code>boolean</code> | | Allow to use `children` field in dynamic choices to nest them. Submitted result will contain array of arrays, every item is a list of values from topmost parent choice down to selected one. |
19+

‎docs/includes/tags/collapse.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| [accordion] | <code>boolean</code> | <code>true</code> | Works as an accordion |
6+
| [bordered] | <code>string</code> | <code>false</code> | Shows border |
7+

‎docs/includes/tags/datetime.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| name | <code>string</code> | | Name of the element |
6+
| toName | <code>string</code> | | Name of the element that you want to label |
7+
| 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 |
8+
| 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 |
9+
| [min] | <code>string</code> | | Set a minimum datetime value for only=date in ISO format, or minimum year for only=year |
10+
| [max] | <code>string</code> | | Set a maximum datetime value for only=date in ISO format, or maximum year for only=year |
11+
| [required] | <code>boolean</code> | <code>false</code> | Whether datetime is required or not |
12+
| [requiredMessage] | <code>string</code> | | Message to show if validation fails |
13+
| [perRegion] | <code>boolean</code> | | Use this option to label regions instead of the whole object |
14+
| [perItem] | <code>boolean</code> | | Use this option to label items inside the object instead of the whole object |
15+

‎docs/includes/tags/ellipse.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| name | <code>string</code> | | Name of the element |
6+
| toName | <code>string</code> | | Name of the image to label |
7+
| [opacity] | <code>float</code> | <code>0.6</code> | Opacity of ellipse |
8+
| [fillColor] | <code>string</code> | | Ellipse fill color in hexadecimal |
9+
| [strokeColor] | <code>string</code> | <code>&quot;#f48a42&quot;</code> | Stroke color in hexadecimal |
10+
| [strokeWidth] | <code>number</code> | <code>1</code> | Width of the stroke |
11+
| [canRotate] | <code>boolean</code> | <code>true</code> | Show or hide rotation control |
12+
| [smart] | <code>boolean</code> | | Show smart tool for interactive pre-annotations |
13+
| [smartOnly] | <code>boolean</code> | | Only show smart tool for interactive pre-annotations |
14+

‎docs/includes/tags/ellipselabels.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| name | <code>string</code> | | Name of the element |
6+
| toName | <code>string</code> | | Name of the image to label |
7+
| [choice] | <code>single</code> \| <code>multiple</code> | <code>single</code> | Configure whether you can select one or multiple labels |
8+
| [maxUsages] | <code>number</code> | | Maximum number of times a label can be used per task |
9+
| [showInline] | <code>boolean</code> | <code>true</code> | Show labels in the same visual line |
10+
| [opacity] | <code>float</code> | <code>0.6</code> | Opacity of ellipse |
11+
| [fillColor] | <code>string</code> | | Ellipse fill color in hexadecimal |
12+
| [strokeColor] | <code>string</code> | | Stroke color in hexadecimal |
13+
| [strokeWidth] | <code>number</code> | <code>1</code> | Width of stroke |
14+
| [canRotate] | <code>boolean</code> | <code>true</code> | Show or hide rotation option |
15+
16+
### Sample Results JSON
17+
18+
| Name | Type | Description |
19+
| --- | --- | --- |
20+
| original_width | <code>number</code> | width of the original image (px) |
21+
| original_height | <code>number</code> | height of the original image (px) |
22+
| image_rotation | <code>number</code> | rotation degree of the image (deg) |
23+
| value | <code>Object</code> | |
24+
| value.x | <code>number</code> | x coordinate of the top left corner before rotation (0-100) |
25+
| value.y | <code>number</code> | y coordinate of the top left corner before rotation (0-100) |
26+
| value.radiusX | <code>number</code> | radius by x axis (0-100) |
27+
| value.radiusY | <code>number</code> | radius by y axis (0-100) |
28+
| value.rotation | <code>number</code> | rotation degree (deg) |
29+
30+
### Example JSON
31+
```json
32+
{
33+
"original_width": 1920,
34+
"original_height": 1280,
35+
"image_rotation": 0,
36+
"value": {
37+
"x": 3.1,
38+
"y": 8.2,
39+
"radiusX": 20,
40+
"radiusY": 16,
41+
"ellipselabels": ["Car"]
42+
}
43+
}
44+
```
45+

‎docs/includes/tags/filter.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| [placeholder] | <code>string</code> | <code>&quot;\&quot;Quick Filter\&quot;&quot;</code> | Placeholder text for filter |
6+
| [minlength] | <code>number</code> | <code>3</code> | Size of the filter |
7+
| [style] | <code>string</code> | | CSS style of the string |
8+
| [hotkey] | <code>string</code> | | Hotkey to use to focus on the filter text area |
9+

‎docs/includes/tags/header.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| value | <code>string</code> | | Text of header, either static text or the field name in data to use for the header |
6+
| [size] | <code>number</code> | <code>4</code> | Level of header on a page, used to control size of the text |
7+
| [style] | <code>string</code> | | CSS style for the header |
8+
| [underline] | <code>boolean</code> | <code>false</code> | Whether to underline the header |
9+

‎docs/includes/tags/hypertext.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| name | <code>string</code> | | Name of the element |
6+
| value | <code>string</code> | | Value of the element |
7+
| [valueType] | <code>url</code> \| <code>text</code> | <code>text</code> | Whether the text is stored directly in uploaded data or needs to be loaded from a URL |
8+
| [inline] | <code>boolean</code> | <code>false</code> | Whether to embed HTML directly in Label Studio or use an iframe |
9+
| [saveTextResult] | <code>yes</code> \| <code>no</code> | | Whether to store labeled text along with the results. By default, doesn't store text for `valueType=url` |
10+
| [encoding] | <code>none</code> \| <code>base64</code> \| <code>base64unicode</code> | | How to decode values from encoded strings |
11+
| [selectionEnabled] | <code>boolean</code> | <code>true</code> | Enable or disable selection |
12+
| [clickableLinks] | <code>boolean</code> | <code>false</code> | Whether to allow opening resources from links in the hypertext markup. |
13+
| [highlightColor] | <code>string</code> | | Hex string with highlight color, if not provided uses the labels color |
14+
| [showLabels] | <code>boolean</code> | | Whether or not to show labels next to the region; unset (by default) — use editor settings; true/false — override settings |
15+
| [granularity] | <code>symbol</code> \| <code>word</code> \| <code>sentence</code> \| <code>paragraph</code> | | Control region selection granularity |
16+
17+
### Sample Results JSON
18+
19+
| Name | Type | Description |
20+
| --- | --- | --- |
21+
| value | <code>Object</code> | |
22+
| value.start | <code>string</code> | xpath of the container where the region starts (xpath) |
23+
| value.end | <code>string</code> | xpath of the container where the region ends (xpath) |
24+
| value.startOffset | <code>number</code> | offset within start container |
25+
| value.endOffset | <code>number</code> | offset within end container |
26+
| [value.text] | <code>string</code> | text content of the region, can be skipped |
27+
28+
### Example JSON
29+
```json
30+
{
31+
"value": {
32+
"start": "/div[1]/p[2]/text()[1]",
33+
"end": "/div[1]/p[4]/text()[3]",
34+
"startOffset": 2,
35+
"endOffset": 81,
36+
"hypertextlabels": ["Car"]
37+
}
38+
}
39+
```
40+

‎docs/includes/tags/hypertextlabels.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
### Parameters
2+
3+
| Param | Type | Default | Description |
4+
| --- | --- | --- | --- |
5+
| name | <code>string</code> | | Name of the element |
6+
| toName | <code>string</code> | | Name of the HTML element to label |
7+
| [choice] | <code>single</code> \| <code>multiple</code> | <code>single</code> | Configure if you can select one or multiple labels |
8+
| [maxUsages] | <code>number</code> | | Maximum number of times a label can be used per task |
9+
| [showInline] | <code>boolean</code> | <code>true</code> | Show labels in the same visual line |
10+
11+
### Sample Results JSON
12+
13+
| Name | Type | Description |
14+
| --- | --- | --- |
15+
| value | <code>Object</code> | |
16+
| value.start | <code>string</code> | xpath of the container where the region starts (xpath) |
17+
| value.end | <code>string</code> | xpath of the container where the region ends (xpath) |
18+
| value.startOffset | <code>number</code> | offset within start container |
19+
| value.endOffset | <code>number</code> | offset within end container |
20+
| [value.text] | <code>string</code> | text content of the region, can be skipped |
21+
22+
### Example JSON
23+
```json
24+
{
25+
"value": {
26+
"start": "/div[1]/p[2]/text()[1]",
27+
"end": "/div[1]/p[4]/text()[3]",
28+
"startOffset": 2,
29+
"endOffset": 81,
30+
"hypertextlabels": ["Car"]
31+
}
32+
}
33+
```
34+

0 commit comments

Comments
 (0)