Label

Properties

  • name Name of this Label

  • group_id Group ID of this Label


Methods

update

update(
   name: str = None, group_id: UUID = None
)

Description

Update this Label with a new name or with a new group.

Examples

a_label.update(name="new name")

Arguments

  • name (str, optional) : New name of this Label

  • group_id (UUID, optional) : New group of this Label


delete

delete()

Description

Delete this Label from the platform. All annotations shape with this label will be deleted! This is a very dangerous move.

⚠️ DANGER ZONE: Be very careful here!

Examples

this_label.delete()

get_group

get_group()

Description

Get (LabelGroup) parent of this Label. If no (LabelGroup) is set, return None.

Examples

group = label_1.get_group()
label_2.set_group(group)

Returns

a (LabelGroup) if there is a parent, else None


set_group

set_group(
   group: LabelGroup
)

Description

Update this Label with a new group.

Examples

a_label.update(name="new name")

Arguments

  • group (LabelGroup) : new group of this Label