Documentation
Search…
Categories and task attributes
When editing the category and task attribute configuration directly, you need to adhere to the following format:

Configuration format

1
{
2
"format_version": "0.1",
3
"categories": [
4
{ ... },
5
{ ... },
6
{ ... }
7
],
8
"image_attributes": [ // optional image-level attributes
9
{ ... },
10
{ ... },
11
{ ... }
12
]
13
}
Copied!
Name
Type
Description
categories
array of categories
Required. List of all possible categories for a label in this dataset.
image_attributes
array of attributes
List of image-level attributes.

Categories

1
{
2
"name": "car",
3
"id": 1,
4
"color": [33, 138, 33], // optional
5
"has_instances": true, // optional
6
"attributes": [ // optional object-level attributes
7
{ ... },
8
{ ... },
9
{ ... }
10
],
11
"dimensions": { // optional, only valid in the point cloud cuboid editor
12
"x": 0.6564944386482239,
13
"y": 1.3789583444595337,
14
"z": 1.6037739515304565
15
},
16
"foo": "bar" // optional custom key-value pairs. These will be ignored.
17
}
Copied!
Name
Type
Description
name
string
Required. Name of the category.
id
int
Required. Index of the category.
color
array of 3 float values in [0, 255]
RGB color of the category.
has_instances
boolean
Whether the category contains instances (person, car) or not (sky, road)
attributes
array of attributes
List of object-level attributes.
dimensions
object: { "x": float, "y": float, "z": float }
Default XYZ dimensions of a new cuboid. Only valid in the point cloud cuboid editor (see Create a cuboid with default dimensions).
...
...
Other key-value pairs can be supplied, but will be ignored.

Attributes

1
{
2
"name": "color",
3
"input_type": "select",
4
"values": [
5
"green",
6
"yellow",
7
"red"
8
],
9
"default_value": "red" // optional
10
}
Copied!
Name
Type
Description
name
string
Required. Name of the attribute.
input_type
string: select | text | number | checkbox
Required. Type of the attribute.
values
array of strings
Required when input_type is select. List of possible values.
min
string
Valid when input_type is number. Minimum value the attribute can be.
max
string
Valid when input_type is number. Maximum value the attribute can be.
step
string
Valid when input_type is number. Step when incrementing/decrementing the value of the attribute.
default_value
string | boolean depending on input_type
Default value of the attribute.

Additional examples

1
{
2
"name": "description",
3
"input_type": "text",
4
"default_value": "A nice car." // optional
5
},
Copied!
1
{
2
"name": "number_of_wheels",
3
"input_type": "number",
4
"min": "1", // optional
5
"max": "20", // optional
6
"step": "1", // optional
7
"default_value": 4 // optional
8
},
Copied!
1
{
2
"name": "is_electric",
3
"input_type": "checkbox",
4
"default_value": false // optional
5
}
Copied!
Note that the inline comments in the examples should be left out, as comments of the form//… or /*…*/ are not allowed in JSON.