DocumentationRecipesReferenceGraphQLChangelog
Log In

Creating a new project

You can either create a project from the graphical user interface or from the API.

To create a new project from the graphical user interface, using our project creation wizard:

  1. Click on the Kili logo in the top-left corner of the screen to get to your project list.
  2. From the project list, click Create New.
  3. Type your project name and description.
  4. Select your asset type.

🚧

  • Asset type is a critical choice. You won't be able to change it later.
  • In Video type project, you will only be able to perform classification and transcription. To be able to use advanced video labeling features like object tracking and label propagation, use a Frame type project. Refer to Labeling video assets.


Available asset types:

  • Image
  • Text
  • PDF
  • Video
  1. Select your project type.

📘

Project templates (types) are made of an asset type and a labeling task.

Some examples:

  • Image Classification [single-class]
  • Image Classification [multi-class]
  • Image Object Detection [polygon]

These three examples are all focused on image as the asset type, but have different labeling tasks.

Project type only helps you bootstrap the configuration on the labeling interface. You can completely change your mind when the project is already created and redefine jobs for your project. Refer to Customizing project interface.

  1. Click Continue.

🚧

When you complete step 1 of the wizard, the new project gets created in Kili app. You won't be able to get back to step 1.

  1. Add assets to your project and then click Continue. For details on adding assets, refer to Adding assets to project. You can skip this step by simply clicking Continue.
  1. Edit your labeling interface (add labeling jobs etc.) For details, refer to Customizing project interface. When done, click Continue. You can skip this step by simply clicking Continue.
  1. Edit your project workflow. Add project members and set quality metrics. For details, refer to Managing project members and Quality management tools. When done, click Finish.
Follow these instructions to create a new project from the API

From the API, you can create a project with a single call, which allows you to store and share project interfaces.

📘

The example below shows how to create an image object classification project. For more information on how to operate Kili API, refer to our API documentation.

  1. Connect to Kili:
# Authentication
import os

# !pip install kili # uncomment if you don't have Kili installed already
from kili.client import Kili

api_key = os.getenv('KILI_USER_API_KEY')
api_endpoint = os.getenv('KILI_API_ENDPOINT') # If you use Kili SaaS, use the url 'https://cloud.kili-technology.com/api/label/v2/graphql'

kili = Kili(api_key=api_key, api_endpoint=api_endpoint)
  1. Set up project interface:
interface = {
  "jobRendererWidth": 0.17,
  "jobs": {
    "JOB_0": {
      "mlTask": "CLASSIFICATION",
      "required": 1,
      "content": {
        "categories": {
          "OBJECT_A": {
            "name": "Object A"
          },
          "OBJECT_B": {
            "name": "Object B"
          }
        },
        "input": "radio"
      }
    }
  }
}
  1. Call the method create_project:
result = kili.create_project(
    title='Project Title',
    description='Project Description',
    input_type='IMAGE',
    json_interface=interface
)
print(result)

When you run the create_project command, it outputs a unique identifier of the project. This identifier is used to access, and modify the project from the API:

Out: {'id': 'ckm4pmqmk0000d49k6ewu2um5'}

Another way to get this project identifier is to look at the URL you're in:


Did this page help you?