Categories and task attributes
When editing the category and task attribute configuration directly, you need to adhere to the following format:
{
"format_version": "0.1",
"categories": [
{ ... },
{ ... },
{ ... }
],
"image_attributes": [ // optional image-level attributes
{ ... },
{ ... },
{ ... }
]
}
Name | Type | Description |
---|---|---|
categories | Required. List of all possible categories for a label in this dataset. | |
image_attributes | List of image-level attributes. |
The
categories
array should contain at least one category.{
"name": "car",
"id": 1,
"color": [33, 138, 33], // optional
"has_instances": true, // optional
"attributes": [ // optional object-level attributes
{ ... },
{ ... },
{ ... }
],
"dimensions": { // optional, only valid in the point cloud cuboid editor
"x": 0.6564944386482239,
"y": 1.3789583444595337,
"z": 1.6037739515304565
},
"foo": "bar" // optional custom key-value pairs. These will be ignored.
}
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 | 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. |
{
"name": "color",
"input_type": "select",
"values": [
"green",
"yellow",
"red"
],
"default_value": "red" // optional
"is_mandatory": true // optional
"is_track_level: true // for sequence interfaces, optional
}
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 string s | 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. |
is_mandatory | boolean | Valid when input_type is select , text or number . Whether the attribute is mandatory. Mandatory attributes raise a warning when not filled in. |
is_track_level | boolean | Valid in sequence datasets. Whether an attribute should remain constant across all frames for an object with a certain track ID. If false, the attribute can change each frame. |
{
"name": "description",
"input_type": "text",
"default_value": "A nice car.", // optional
"is_mandatory": true // optional
},
{
"name": "number_of_wheels",
"input_type": "number",
"min": "1", // optional
"max": "20", // optional
"step": "1", // optional
"default_value": 4, // optional
"is_mandatory": true // optional
},
{
"name": "is_electric",
"input_type": "checkbox",
"default_value": false // optional
}
Note that the inline comments in the examples should be left out, as comments of the form
//…
or /*…*/
are not allowed in JSON.Last modified 7mo ago