kili

Kili Command line Interface

To get all the available commands, please type: kili project --help.

Usage:

kili [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--version	boolean	Show the version and exit.	False
--help	boolean	Show this message and exit.	False

project

Commands to interact with a Kili project

Usage:

kili project [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

create

Create a Kili project

If --interface is the project_id of another Kili project, it will create a new project with the same json_interface (assets will not be copied).

Examples

kili project create \
    --interface path/to/interface.json \
    --input-type TEXT \
    --title "Invoice annotation project"

kili project create \
    --interface another_project_id \
    --input-type TEXT \
    --title "Invoice annotation project"

To build a Kili project interface, please visit:

https://docs.kili-technology.com/docs/customizing-the-interface-through-json-settings

Usage:

kili project create [OPTIONS]

Options:

Name	Type	Description	Default
--api-key	text	Your Kili API key.	None
--endpoint	text	Kili API Endpoint.	None
--interface	text	Path pointing to your json interface file or the project_id of another Kili project.	_required
--title	text	Project Title.	_required
--input-type	choice (AUDIO | FRAME | IMAGE | PDF | TEXT | TIME_SERIES | VIDEO)	Project input data type. Please check your license to see which ones you have access to.	_required
--description	text	Project description.	``
--stdout-format	text	Defines how the output table is formatted (see https://pypi.org/project/tabulate/, default: plain).	plain
--help	boolean	Show this message and exit.	False

describe

Show project description and analytics

Examples

kili project describe --project-id <project_id>

Usage:

kili project describe [OPTIONS] PROJECT_ID

Options:

Name	Type	Description	Default
--api-key	text	Your Kili API key.	None
--endpoint	text	Kili API Endpoint.	None
--help	boolean	Show this message and exit.	False

import

Add assets into a project

Files can be paths to files or to folders. You can provide several paths separated by spaces.

Examples

kili project import \
    dir1/dir2/ dir1/dir3/test1.png \
    --project-id <project_id> \
    --exclude dontimport.png

kili project import \
    dir1/dir3/video.mp4 \
    --project-id <project_id> \
    --frames \
    --fps 24

Unsupported imports

Currently, this command does not support:

• the import of videos from local frames, rich text and time series assets
• the import of assets with metadata or with a custom external_id

For such imports, please use the append_many_to_dataset method in the Kili SDK.

Usage:

kili project import [OPTIONS] FILES...

Options:

Name	Type	Description	Default
--api-key	text	Your Kili API key.	None
--endpoint	text	Kili API Endpoint.	None
--project-id	text	Id of the project to import assets into.	_required
--exclude	path	Files to exclude from the given files	None
--frames	boolean	Only for a frame project, import videos as frames. The import time is longer with this option.	False
--fps	integer	Only for a frame project, import videos with a specific frame rate	None
--verbose	boolean	Show logs	False
--help	boolean	Show this message and exit.	False

label

Import labels or predictions

The labels to import have to be in the Kili format and stored in a json file. Labels to import are provided in a CSV file with two columns, separated by a semi-column:

• external_id: external id for which you want to import labels.
• json_response_path: paths to the json files containing the json_response to upload.

CSV file template

external_id;json_response_path
asset1;./labels/label_asset1.json
asset2;./labels/label_asset2.json

Examples

To import default labels:

kili project label \
    path/to/file.csv \
    --project-id <project_id>

To import labels as predictions:

kili project label \
    path/to/file.csv \
    --project-id <project_id> \
    --prediction \
    --model-name YOLO-run-3

Usage:

kili project label [OPTIONS] CSV_PATH

Options:

Name	Type	Description	Default
--api-key	text	Your Kili API key.	None
--endpoint	text	Kili API Endpoint.	None
--project-id	text	Id of the project to import labels in	_required
--prediction	boolean	Tells to import labels as predictions, which means that they will appear as pre-annotations in the Kili interface	False
--model-name	text	Name of the model that generated predictions, if labels are sent as predictions	None
--help	boolean	Show this message and exit.	False

list

List your projects

Examples

kili project list --max 10 --format pretty

Usage:

kili project list [OPTIONS]

Options:

Name	Type	Description	Default
--api-key	text	Your Kili API key.	None
--endpoint	text	Kili API Endpoint.	None
--stdout-format	text	Defines how the output table is formatted (see https://pypi.org/project/tabulate/, default: plain).	plain
--max	integer	Maximum number of project to display.	100
--help	boolean	Show this message and exit.	False