The official Python SDK for FastLabel API, the Data Platform for AI

Project description

FastLabel Python SDK

If you are using FastLabel prototype, please install version 0.2.2.

Installation
Usage
- Limitation
Task
Annotation
Project
Converter
- COCO
- YOLO
- Pascal VOC
- labelme
- Segmentation

Installation

pip install --upgrade fastlabel

Python version 3.7 or greater is required

Usage

Configure API Key in environment variable.

export FASTLABEL_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"

Initialize fastlabel client.

import fastlabel
client = fastlabel.Client()

Limitation

API is allowed to call 10000 times per 10 minutes. If you create/delete a large size of tasks, please wait a second for every requests.

Task

Image

Supported following project types:

Image - Bounding Box
Image - Polygon
Image - Keypoint
Image - Line
Image - Segmentation
Image - All

Create Task

Create a new task.

task_id = client.create_image_task(
    project="YOUR_PROJECT_SLUG",
    name="sample.jpg",
    file_path="./sample.jpg"
)

Create a new task with pre-defined annotations. (Class should be configured on your project in advance)

task_id = client.create_image_task(
    project="YOUR_PROJECT_SLUG",
    name="sample.jpg",
    file_path="./sample.jpg",
    annotations=[{
        "type": "bbox",
        "value": "annotation-value",
        "attributes": [
            {
                "key": "attribute-key",
                "value": "attribute-value"
            }
        ],
        "points": [
            100,  # top-left x
            100,  # top-left y
            200,  # bottom-right x
            200   # bottom-right y
        ]
    }]
)

Check examples/create_image_task.py.

Find Task

Find a single task.

task = client.find_image_task(task_id="YOUR_TASK_ID")

Find a single task by name.

tasks = client.find_image_task_by_name(project="YOUR_PROJECT_SLUG", task_name="YOUR_TASK_NAME")

Get Tasks

Get tasks. (Up to 1000 tasks)

tasks = client.get_image_tasks(project="YOUR_PROJECT_SLUG")

Filter and Get tasks. (Up to 1000 tasks)

tasks = client.get_image_tasks(
    project="YOUR_PROJECT_SLUG",
    status="approved", # status can be 'registered', 'completed', 'skipped', 'sent_back', 'approved', 'customer_sent_back', 'customer_approved'
    tags=["tag1", "tag2"] # up to 10 tags
)

Get a large size of tasks. (Over 1000 tasks)

import time

# Iterate pages until new tasks are empty.
all_tasks = []
offset = None
while True:
    time.sleep(1)

    tasks = client.get_image_tasks(project="YOUR_PROJECT_SLUG", offset=offset)
    all_tasks.extend(tasks)

    if len(tasks) > 0:
        offset = len(all_tasks)  # Set the offset
    else:
        break

Please wait a second before sending another requests!

Response

Example of a single image task object

{
    "id": "YOUR_TASK_ID",
    "name": "cat.jpg",
    "width": 100,   # image width
    "height": 100,  # image height
    "url": "YOUR_TASK_URL",
    "status": "registered",
    "tags": [],
    "assignee": "ASSIGNEE_NAME",
    "reviewer": "REVIEWER_NAME",
    "customerReviewer": "CUSTOMER_REVIEWER_NAME",
    "annotations": [
        {
            "attributes": [
                { "key": "kind", "name": "Kind", "type": "text", "value": "Scottish field" }
            ],
            "color": "#b36d18",
            "points": [
                100,  # top-left x
                100,  # top-left y
                200,  # bottom-right x
                200   # bottom-right y
            ],
            "title": "Cat",
            "type": "bbox",
            "value": "cat"
        }
    ],
    "createdAt": "2021-02-22T11:25:27.158Z",
    "updatedAt": "2021-02-22T11:25:27.158Z"
}

Image Classification

Supported following project types:

Image - Classification

Create Task

Create a new task.

task_id = client.create_image_classification_task(
    project="YOUR_PROJECT_SLUG",
    name="sample.jpg",
    file_path="./sample.jpg",
    attributes=[
        {
            "key": "attribute-key",
            "value": "attribute-value"
        }
    ],
)

Find Task

Find a single task.

task = client.find_image_classification_task(task_id="YOUR_TASK_ID")

Get Tasks

Get tasks. (Up to 1000 tasks)

tasks = client.get_image_classification_tasks(project="YOUR_PROJECT_SLUG")

Update Tasks

Update a signle task.

task_id = client.update_image_classification_task(
    task_id="YOUR_TASK_ID",
    status="approved",
    tags=["tag1", "tag2"]
    attributes=[
        {
            "key": "attribute-key",
            "value": "attribute-value"
        }
    ],
)

Response

Example of a single image classification task object

{
    "id": "YOUR_TASK_ID",
    "name": "cat.jpg",
    "width": 100,   # image width
    "height": 100,  # image height
    "url": "YOUR_TASK_URL",
    "status": "registered",
    "tags": [],
    "assignee": "ASSIGNEE_NAME",
    "reviewer": "REVIEWER_NAME",
    "customerReviewer": "CUSTOMER_REVIEWER_NAME",
    "attributes": [
        {
            "key": "kind",
            "name": "Kind",
            "type": "text",
            "value": "Scottish field"
        }
    ],
    "createdAt": "2021-02-22T11:25:27.158Z",
    "updatedAt": "2021-02-22T11:25:27.158Z"
}

Multi Image

Supported following project types:

Multi Image - Bounding Box
Multi Image - Polygon
Multi Image - Keypoint
Multi Image - Line
Multi Image - Segmentation

Create Task

Create a new task.

task = client.create_multi_image_task(
    project="YOUR_PROJECT_SLUG",
    name="sample",
    folder_path="./sample",
    annotations=[{
        "type": "segmentation",
        "value": "annotation-value",
        "attributes": [
            {
                "key": "attribute-key",
                "value": "attribute-value"
            }
        ],
        "content": "01.jpg",
        "points": [[[
            100,
            100,
            300,
            100,
            300,
            300,
            100,
            300,
            100,
            100
        ]]] # clockwise rotation
    }]
)

Find Task

Find a single task.

task = client.find_multi_image_task(task_id="YOUR_TASK_ID")

Get Tasks

Get tasks.

tasks = client.get_multi_image_tasks(project="YOUR_PROJECT_SLUG")

Response

Example of a single task object

{
    "id": "YOUR_TASK_ID",
    "name": "cat.jpg",
    "contents": [
        {
            "name": "content-name",
            "url": "content-url",
            "width": 100,
            "height": 100,
        }
    ],
    "status": "registered",
    "tags": [],
    "assignee": "ASSIGNEE_NAME",
    "reviewer": "REVIEWER_NAME",
    "customerReviewer": "CUSTOMER_REVIEWER_NAME",
    "annotations": [
        {
            "content": "content-name"
            "attributes": [],
            "color": "#b36d18",
            "points": [[[
                100,
                100,
                300,
                100,
                300,
                300,
                100,
                300,
                100,
                100
            ]]]
            "title": "Cat",
            "type": "bbox",
            "value": "cat"
        }
    ],
    "createdAt": "2021-02-22T11:25:27.158Z",
    "updatedAt": "2021-02-22T11:25:27.158Z"
}

Video

Supported following project types:

Video - Bounding Box

Create Task

Create a new task.

task_id = client.create_video_task(
    project="YOUR_PROJECT_SLUG",
    name="sample.mp4",
    file_path="./sample.mp4"
)

Create a new task with pre-defined annotations. (Class should be configured on your project in advance)

task_id = client.create_video_task(
    project="YOUR_PROJECT_SLUG",
    name="sample.mp4",
    file_path="./sample.mp4",
    annotations=[{
        "type": "bbox",
        "value": "person",
        "points": {
            "1": {  # number of frame
                "value": [
                    100,  # top-left x
                    100,  # top-left y
                    200,  # bottom-right x
                    200   # bottom-right y
                ],
                # Make sure to set `autogenerated` False for the first and last frame. "1" and "3" frames in this case.
                # Otherwise, annotation is auto-completed for rest of frames when you edit.
                "autogenerated": False
            },
            "2": {
                "value": [
                    110,
                    110,
                    220,
                    220
                ],
                "autogenerated": True
            },
            "3": {
                "value": [
                    120,
                    120,
                    240,
                    240
                ],
                "autogenerated": False
            }
        }
    }]
)

Find Task

Find a single task.

task = client.find_video_task(task_id="YOUR_TASK_ID")

Get Tasks

Get tasks. (Up to 10 tasks)

tasks = client.get_video_tasks(project="YOUR_PROJECT_SLUG")

Response

Example of a single image classification task object

{
    "id": "YOUR_TASK_ID",
    "name": "cat.jpg",
    "width": 100,   # image width
    "height": 100,  # image height
    "fps": 30.0,    # frame per seconds
    "frameCount": 480,  # total frame count of video
    "duration": 16.0,   # total duration of video
    "url": "YOUR_TASK_URL",
    "status": "registered",
    "tags": [],
    "assignee": "ASSIGNEE_NAME",
    "reviewer": "REVIEWER_NAME",
    "customerReviewer": "CUSTOMER_REVIEWER_NAME",
    "annotations": [
        {
            "attributes": [],
            "color": "#b36d18",
            "points": {
                "1": {  # number of frame
                    "value": [
                        100,  # top-left x
                        100,  # top-left y
                        200,  # bottom-right x
                        200   # bottom-right y
                    ],
                    "autogenerated": False  # False when annotated manually. True when auto-generated by system.
                },
                "2": {
                    "value": [
                        110,
                        110,
                        220,
                        220
                    ],
                    "autogenerated": True
                },
                "3": {
                    "value": [
                        120,
                        120,
                        240,
                        240
                    ],
                    "autogenerated": False
                }
            },
            "title": "Cat",
            "type": "bbox",
            "value": "cat"
        }
    ],
    "createdAt": "2021-02-22T11:25:27.158Z",
    "updatedAt": "2021-02-22T11:25:27.158Z"
}

Video Classification

Supported following project types:

Video - Classification (Single)

Get Tasks

Get tasks. (Up to 1000 tasks)

tasks = client.get_video_classification_tasks(project="YOUR_PROJECT_SLUG")

Update Tasks

Update a signle task.

task_id = client.update_video_classification_task(
    task_id="YOUR_TASK_ID",
    status="approved",
    tags=["tag1", "tag2"]
    attributes=[
        {
            "key": "attribute-key",
            "value": "attribute-value"
        }
    ],
)

Common

APIs for update and delete are same over all tasks.

Update Task

Update a single task status and tags.

task_id = client.update_task(
    task_id="YOUR_TASK_ID",
    status="approved",
    tags=["tag1", "tag2"]
)

Delete Task

Delete a single task.

client.delete_task(task_id="YOUR_TASK_ID")

Get Tasks Id and Name map

id_name_map = client.get_task_id_name_map(project="YOUR_PROJECT_SLUG")

Annotation

Create Annotaion

Create a new annotation.

annotation_id = client.create_annotation(
    project="YOUR_PROJECT_SLUG", type="bbox", value="cat", title="Cat")

Create a new annotation with color and attributes.

attributes = [
    {
        "type": "text",
        "name": "Kind",
        "key": "kind"
    },
    {
        "type": "select",
        "name": "Size",
        "key": "size",
        "options": [ # select, radio and checkbox type requires options
            {
                "title": "Large",
                "value": "large"
            },
            {
                "title": "Small",
                "value": "small"
            },
        ]
    },
]
annotation_id = client.create_annotation(
    project="YOUR_PROJECT_SLUG", type="bbox", value="cat", title="Cat", color="#FF0000", attributes=attributes)

Create a new classification annotation.

annotation_id = client.create_classification_annotation(
    project="YOUR_PROJECT_SLUG", attributes=attributes)

Find Annotation

Find an annotation.

annotation = client.find_annotation(annotation_id="YOUR_ANNOTATION_ID")

Find an annotation by value.

annotation = client.find_annotation_by_value(project="YOUR_PROJECT_SLUG", value="cat")

Find an annotation by value in classification project.

annotation = client.find_annotation_by_value(
    project="YOUR_PROJECT_SLUG", value="classification") # "classification" is fixed value

Get Annotations

Get annotations. (Up to 1000 annotations)

annotations = client.get_annotations(project="YOUR_PROJECT_SLUG")

Response

Example of an annotation object

{
    "id": "YOUR_ANNOTATION_ID",
    "type": "bbox",
    "value": "cat",
    "title": "Cat",
    "color": "#FF0000",
    "attributes": [
        {
            "id": "YOUR_ATTRIBUTE_ID",
            "key": "kind",
            "name": "Kind",
            "options": [],
            "type": "text",
            "value": ""
        },
        {
            "id": "YOUR_ATTRIBUTE_ID",
            "key": "size",
            "name": "Size",
            "options": [
                {"title": "Large", "value": "large"},
                {"title": "Small", "value": "small"}
            ],
            "type": "select",
            "value": ""
        }
    ],
    "createdAt": "2021-05-25T05:36:50.459Z",
    "updatedAt": "2021-05-25T05:36:50.459Z"
}

Update Annotation

Update an annotation.

annotation_id = client.update_annotation(
    annotation_id="YOUR_ANNOTATION_ID", value="cat2", title="Cat2", color="#FF0000")

Update an annotation with attributes.

attributes = [
    {
        "id": "YOUR_ATTRIBUTE_ID",  # check by sdk get methods
        "type": "text",
        "name": "Kind2",
        "key": "kind2"
    },
    {
        "id": "YOUR_ATTRIBUTE_ID",
        "type": "select",
        "name": "Size2",
        "key": "size2",
        "options": [
            {
                "title": "Large2",
                "value": "large2"
            },
            {
                "title": "Small2",
                "value": "small2"
            },
        ]
    },
]
annotation_id = client.update_annotation(
    annotation_id="YOUR_ANNOTATION_ID", value="cat2", title="Cat2", color="#FF0000", attributes=attributes)

Update a classification annotation.

annotation_id = client.update_classification_annotation(
    project="YOUR_PROJECT_SLUG", attributes=attributes)

Delete Annotation

Delete an annotation.

client.delete_annotation(annotation_id="YOUR_ANNOTATION_ID")

Project

Create Project

Create a new project.

project_id = client.create_project(
    type="image_bbox", name="ImageNet", slug="image-net")

Find Project

Find a project.

project = client.find_project(project_id="YOUR_PROJECT_ID")

Find a project by slug.

project = client.find_project_by_slug(slug="YOUR_PROJECT_SLUG")

Get Projects

Get projects. (Up to 1000 projects)

projects = client.get_projects()

Response

Example of a project object

{
    "id": "YOUR_PROJECT_ID",
    "type": "image_bbox",
    "slug": "YOUR_PROJECT_SLUG",
    "name": "YOUR_PROJECT_NAME",
    "isBitmap": False,
    "jobSize": 10,
    "useAnnotationService": False,
    "status": "active",
    "createdAt": "2021-04-20T03:20:41.427Z",
    "updatedAt": "2021-04-20T03:20:41.427Z",
}

Update Project

Update a project.

project_id = client.update_project(
    project_id="YOUR_PROJECT_ID", name="NewImageNet", slug="new-image-net", job_size=20)

Delete Project

Delete a project.

client.delete_project(project_id="YOUR_PROJECT_ID")

Converter

Supporting bbox or polygon annotation type.

COCO

Get tasks and export as a COCO format file.

tasks = client.get_image_tasks(project="YOUR_PROJECT_SLUG")
client.export_coco(tasks)

Export with specifying output directory.

client.export_coco(tasks=tasks, output_dir="YOUR_DIRECTROY")

YOLO

Get tasks and export as YOLO format files.

tasks = client.get_image_tasks(project="YOUR_PROJECT_SLUG")
client.export_yolo(tasks)

Pascal VOC

Get tasks and export as Pascal VOC format files.

tasks = client.get_image_tasks(project="YOUR_PROJECT_SLUG")
client.export_pascalvoc(tasks)

labelme

Get tasks and export as labelme format files.

tasks = client.get_image_tasks(project="YOUR_PROJECT_SLUG")
client.export_labelme(tasks)

Segmentation

Get tasks and export index color instance/semantic segmentation (PNG files). Only support the following annotation types.

bbox
polygon
segmentation (Hollowed points are not supported.)

tasks = client.get_image_tasks(project="YOUR_PROJECT_SLUG")
client.export_instance_segmentation(tasks)

tasks = client.get_image_tasks(project="YOUR_PROJECT_SLUG")
client.export_semantic_segmentation(tasks)

Please check const.COLOR_PALLETE for index colors.

API Docs

Check this for further information.

Project details

Release history Release notifications | RSS feed

0.14.13

Apr 17, 2024

0.14.12

Jan 27, 2024

0.14.11

Jan 11, 2024

0.14.10

Jan 9, 2024

0.14.9

Dec 20, 2023

0.14.8

Dec 15, 2023

0.14.7

Dec 11, 2023

0.14.6

Nov 6, 2023

0.14.5

Oct 30, 2023

0.14.4

Oct 17, 2023

0.14.3

Sep 22, 2023

0.14.2

Sep 16, 2023

0.14.1

Sep 11, 2023

0.14.0

Sep 4, 2023

0.13.0

Aug 21, 2023

0.12.9

Aug 21, 2023

0.12.8

Aug 21, 2023

0.12.7

Aug 17, 2023

0.12.6

Aug 16, 2023

0.12.5

Aug 7, 2023

0.12.4

Aug 2, 2023

0.12.3

Jul 26, 2023

0.12.2

Jul 21, 2023

0.12.1

Jul 15, 2023

0.12.0

Jul 7, 2023

0.11.44

Jun 30, 2023

0.11.43

Jun 27, 2023

0.11.42

Jun 23, 2023

0.11.41

Jun 22, 2023

0.11.40

Jun 12, 2023

0.11.39

May 26, 2023

0.11.38

May 8, 2023

0.11.37

Apr 20, 2023

0.11.36

Apr 19, 2023

0.11.35

Apr 17, 2023

0.11.34

Apr 10, 2023

0.11.33

Apr 3, 2023

0.11.32

Mar 31, 2023

0.11.31

Mar 24, 2023

0.11.30

Mar 14, 2023

0.11.29

Feb 15, 2023

0.11.28

Nov 18, 2022

0.11.27

Oct 28, 2022

0.11.26

Oct 19, 2022

0.11.25

Oct 11, 2022

0.11.24

Sep 26, 2022

0.11.23

Sep 15, 2022

0.11.22

Jul 4, 2022

0.11.21

Jul 1, 2022

0.11.20

Jun 16, 2022

0.11.19

May 30, 2022

0.11.18

May 9, 2022

0.11.17

Mar 22, 2022

0.11.16

Mar 16, 2022

0.11.15

Mar 5, 2022

0.11.14

Feb 24, 2022

0.11.13

Jan 27, 2022

0.11.12

Dec 13, 2021

0.11.11

Dec 9, 2021

0.11.10

Dec 2, 2021

0.11.9

Nov 26, 2021

0.11.8

Nov 25, 2021

0.11.7

Nov 15, 2021

0.11.6

Nov 2, 2021

0.11.5

Oct 31, 2021

0.11.4

Oct 18, 2021

0.11.3

Sep 11, 2021

0.11.2

Sep 6, 2021

0.11.1

Aug 27, 2021

0.11.0

Aug 13, 2021

0.10.0

Aug 10, 2021

0.9.10

Aug 4, 2021

0.9.9

Jul 30, 2021

This version

0.9.8 yanked

Jul 30, 2021

0.9.7

Jul 27, 2021

0.9.6

Jul 23, 2021

0.9.5

Jul 19, 2021

0.9.4

Jul 3, 2021

0.9.3

Jun 30, 2021

0.9.2

Jun 20, 2021

0.9.1

Jun 13, 2021

0.9.0

Jun 2, 2021

0.8.1

May 26, 2021

0.8.0

May 26, 2021

0.7.1

May 25, 2021

0.7.0

May 23, 2021

0.6.0

May 21, 2021

0.5.0

May 14, 2021

0.4.2

May 13, 2021

0.4.1

May 13, 2021

0.4.0

May 2, 2021

0.3.1

Feb 26, 2021

0.3.0

Feb 24, 2021

0.2.2

Feb 1, 2021

0.2.1

Jan 24, 2021

0.2.0

Dec 26, 2020

0.1.1

Dec 19, 2020

0.1.0

Dec 18, 2020

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastlabel-0.9.8.tar.gz (17.7 kB view hashes)

Uploaded Jul 30, 2021 Source

Built Distribution

fastlabel-0.9.8-py3-none-any.whl (15.7 kB view hashes)

Uploaded Jul 30, 2021 Python 3

Hashes for fastlabel-0.9.8.tar.gz

Hashes for fastlabel-0.9.8.tar.gz
Algorithm	Hash digest
SHA256	`3f796faa5425f8c66b952973818bb9b2efd34cd808a56d920ff8130c48cda197`
MD5	`4925d27b4186071d8567d35d44fa2a47`
BLAKE2b-256	`57be7f95f0710f3736b944abf8635802ed7c4fa9ed908af29b88814533d5d1aa`

Hashes for fastlabel-0.9.8-py3-none-any.whl

Hashes for fastlabel-0.9.8-py3-none-any.whl
Algorithm	Hash digest
SHA256	`ad54ca632026d7d10bff91ed05331d565f7cb9b1f2a04d049959ef59558dd79e`
MD5	`971c7af062d26a763a89f618e220e323`
BLAKE2b-256	`eedac00c7d5cccab45e68c77905782025e66c168e32fc915434969e19e658060`

fastlabel 0.9.8

Navigation

Verified details

Maintainers

Unverified details

GitHub Statistics

Meta

Project description

FastLabel Python SDK

Table of Contents

Installation

Usage

Limitation

Task

Image

Create Task

Find Task

Get Tasks

Response

Image Classification

Create Task

Find Task

Get Tasks

Update Tasks

Response

Multi Image

Create Task

Find Task

Get Tasks

Response

Video

Create Task

Find Task

Get Tasks

Response

Video Classification

Get Tasks

Update Tasks

Common

Update Task

Delete Task

Get Tasks Id and Name map

Annotation

Create Annotaion

Find Annotation

Get Annotations

Response

Update Annotation

Delete Annotation

Project

Create Project

Find Project

Get Projects

Response

Update Project

Delete Project

Converter

COCO

YOLO

Pascal VOC

labelme

Segmentation

API Docs

Project details

Verified details

Maintainers

Unverified details

GitHub Statistics

Meta

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution