Customize interface

All interfaces (excepted custom interfaces) are divided in two parts:

• the asset viewer on the left
• the jobs viewer on the right

Jobs are implementation of machine learning tasks (such as classification, object detection, etc). Interfaces can chain several jobs one after the other. Each job can be either required or optional.

Interface can be customized with the interface builder or in JSON settings.

Interface builder

This is a the builder to easily customize the interface. It is accessible in the Settings tab.

An interface is composed of

• Asset type (image, text, video, audio)
• Machine Learning task (classification, object detection, named entity recognition, ...)
• Input (radio button, check box, dropdown)
• Tool (bounding box, polygon, line,...)

An interface can have: one job

Several jobs

You can add as many jobs as needed for your labeling task.

Or nested jobs

To nest a job, you click on the arrow at the class level.

Meta data

The app allows to add to the asset extra information, called meta data. Meta data are to be uploaded through the API. It can be an image and/or a text, and/or an URL. The code below shows how to attach meta data to an asset with Kili Playground:

metadata = {
    'imageUrl': 'https://myriadrbm.com/wp-content/blogs.dir/20/files/2018/05/cell-3.png',
    'text': 'Normal cell',
    'url': 'https://www.google.com'
}
playground.update_properties_in_asset(
    asset_id=asset_id,
    json_metadata=metadata)

You can find more information on the API here or directly in the github of the project.

Custom render width

Renderer width is a parameter in the JSON file. It has to be between 0 and 1, and is the proportion of the screen given to the annotation tools (the jobs). The rest of the screen is for the asset. Key: jobRendererWidth : (here 0.2, i.e. 20%)

Custom classes' colors

Color of a class is a parameter in the JSON file. Color code is the color hex code (hexadecimal). Key: color: "#941100"

JSON settings

The JSON settings fully describes an interface. For 3 successive classification jobs for instance, it is composed as such:

{
    "filetype": "PDF",
    "jobRendererWidth": 0.25,
    "jobs": {
        "CLASSIFICATION_JOB": {
            "mlTask": "CLASSIFICATION",
            "content": {
                "categories": {
                    "ECONOMICS": {
                        "name": "economics",
                        "color": "#941100",
                        "children": []
                    },
                    "MATHEMATICS": {
                        "name": "mathematics",
                        "children": []
                    },
                    "DATA_SCIENCE": {
                        "name": "data-science",
                        "children": []
                    },
                    "ANTHROPOLOGY": {
                        "name": "anthropology",
                        "children": []
                    }
                },
                "input": "radio"
            },
            "required": 1,
            "isChild": false,
            "instruction": "What is the topic of this paper ?"
        },
        "NAMED_ENTITIES_RECOGNITION_JOB": {
            "mlTask": "NAMED_ENTITIES_RECOGNITION",
            "content": {
                "categories": {
                    "ACTIVE_LEARNING": {
                        "name": "active learning",
                        "color": "#73FDFF"
                    },
                    "DATA_TYPE": {
                        "name": "data type",
                        "color": "#9437FF"
                    },
                    "MACHINE_LEARNING": {
                        "name": "machine learning",
                        "color": "#FF9900"
                    },
                    "AUTHORS": {
                        "name": "authors",
                        "color": "#FF40FF"
                    }
                },
                "input": "radio"
            },
            "required": 1,
            "tools": [
                null
            ],
            "isChild": false,
            "instruction": "Identify terms specific to"
        }
    }
}

The JSON can be saved, to duplicate a project for example, but also edited interactively.