Types#

Datasets#

class Dataset[source]#

field name: str#

field full_name: str#

field cloned_from: Optional[str]#

field description: str#

field category: str#

Validated by

check_category

field public: bool#

field owner: segments.typing.Owner#

field created_at: str#

field enable_ratings: bool#

field enable_skip_labeling: bool#

field enable_skip_reviewing: bool#

field enable_save_button: bool#

field enable_label_status_verified: bool#

field enable_same_dimensions_track_constraint: bool#

field enable_interpolation: bool#

field task_type: typing_extensions.Literal[segmentation-bitmap, segmentation-bitmap-highres, image-vector-sequence, bboxes, vector, pointcloud-cuboid, pointcloud-cuboid-sequence, pointcloud-segmentation, pointcloud-segmentation-sequence, pointcloud-vector, pointcloud-vector-sequence, text-named-entities, text-span-categorization, ]#

field label_stats: segments.typing.LabelStats#

field samples_count: Optional[Union[str, int]]#

field collaborators_count: Optional[int]#

field task_attributes: Optional[segments.typing.TaskAttributes]#

field labelsets: Optional[List[segments.typing.Labelset]]#

field role: Optional[str]#

field readme: Optional[str]#

field noncollaborator_can_label: Optional[bool]#

field noncollaborator_can_review: Optional[bool]#

field embeddings_enabled: Optional[bool]#

class Collaborator[source]#

field user: segments.typing.User#

field role: typing_extensions.Literal[labeler, reviewer, admin]#

class User[source]#

field username: str#

field created_at: str#

Samples#

class Sample[source]#

field uuid: str#

field name: str#

field attributes: Union[segments.typing.ImageSampleAttributes, segments.typing.ImageSequenceSampleAttributes, segments.typing.PointcloudSampleAttributes, segments.typing.PointcloudSequenceSampleAttributes, segments.typing.TextSampleAttributes]#

field metadata: Dict[str, Any]#

field created_at: str#

field created_by: str#

field assigned_labeler: Optional[str]#

field assigned_reviewer: Optional[str]#

field comments: Optional[List[str]]#

field priority: float#

field has_embedding: Optional[bool]#

field label: Optional[segments.typing.Label]#

field issues: Optional[List[segments.typing.Issue]]#

field dataset_full_name: Optional[str]#

Image#

class ImageSampleAttributes[source]#

field image: segments.typing.URL#

Image sequence#

class ImageSequenceSampleAttributes[source]#

field frames: List[segments.typing.ImageFrame]#

class ImageFrame[source]#

Bases: ImageSampleAttributes

field name: Optional[str]#

Point cloud#

class PointcloudSampleAttributes[source]#

field pcd: segments.typing.PCD#

field images: Optional[List[segments.typing.CalibratedImage]]#

field ego_pose: Optional[segments.typing.EgoPose]#

field default_z: Optional[float]#

field name: Optional[str]#

field timestamp: Optional[Union[str, int]]#

Point cloud sequence#

class PointcloudSequenceSampleAttributes[source]#

field frames: List[segments.typing.PointcloudSampleAttributes]#

Text#

class TextSampleAttributes[source]#

field text: str#

Labels#

class Label[source]#

field sample_uuid: str#

field label_type: typing_extensions.Literal[segmentation-bitmap, segmentation-bitmap-highres, image-vector-sequence, bboxes, vector, pointcloud-cuboid, pointcloud-cuboid-sequence, pointcloud-segmentation, pointcloud-segmentation-sequence, pointcloud-vector, pointcloud-vector-sequence, text-named-entities, text-span-categorization, ]#

field label_status: typing_extensions.Literal[REVIEWED, REVIEWING_IN_PROGRESS, LABELED, LABELING_IN_PROGRESS, REJECTED, PRELABELED, SKIPPED, UNLABELED, VERIFIED]#

field labelset: str#

field attributes: Union[segments.typing.ImageVectorLabelAttributes, segments.typing.ImageSegmentationLabelAttributes, segments.typing.ImageSequenceVectorLabelAttributes, segments.typing.PointcloudCuboidLabelAttributes, segments.typing.PointcloudVectorLabelAttributes, segments.typing.PointcloudSegmentationLabelAttributes, segments.typing.PointcloudSequenceCuboidLabelAttributes, segments.typing.PointcloudSequenceVectorLabelAttributes, segments.typing.PointcloudSequenceSegmentationLabelAttributes, segments.typing.TextLabelAttributes]#

field created_at: str#

field created_by: str#

field updated_at: str#

field score: Optional[float]#

field rating: Optional[float]#

field reviewed_at: Optional[str]#

field reviewed_by: Optional[str]#

Image segmentation#

class ImageSegmentationLabelAttributes[source]#

field annotations: List[segments.typing.Annotation]#

field segmentation_bitmap: segments.typing.URL#

field image_attributes: Optional[Dict[str, Optional[Union[str, bool]]]]#

field format_version: Optional[Union[float, str]]#

class Annotation[source]#

field id: int#

field category_id: int#

field attributes: Optional[Dict[str, Optional[Union[str, bool]]]]#

Image vector#

class ImageVectorLabelAttributes[source]#

field annotations: List[segments.typing.ImageVectorAnnotation]#

field format_version: Optional[Union[float, str]]#

field image_attributes: Optional[Dict[str, Optional[Union[str, bool]]]]#

class ImageVectorAnnotation[source]#

field id: int#

field category_id: int#

field points: List[List[float]]#

field type: typing_extensions.Literal[bbox, polygon, polyline, point]#

field attributes: Optional[Dict[str, Optional[Union[str, bool]]]]#

Image sequence vector#

class ImageSequenceVectorLabelAttributes[source]#

field frames: List[segments.typing.ImageVectorFrame]#

field format_version: Optional[Union[float, str]]#

class ImageVectorFrame[source]#

field annotations: List[segments.typing.ImageSequenceVectorAnnotation]#

field timestamp: Optional[Union[str, int]]#

field format_version: Optional[Union[float, str]]#

field image_attributes: Optional[Dict[str, Optional[Union[str, bool]]]]#

class ImageSequenceVectorAnnotation[source]#

Bases: ImageVectorAnnotation

field track_id: int#

field is_keyframe: bool#

Point cloud segmentation#

class PointcloudSegmentationLabelAttributes[source]#

field annotations: List[segments.typing.Annotation]#

field point_annotations: List[int]#

field format_version: Optional[Union[float, str]]#

Point cloud cuboid#

class PointcloudCuboidLabelAttributes[source]#

field annotations: List[segments.typing.PointcloudCuboidAnnotation]#

field format_version: Optional[Union[float, str]]#

class PointcloudCuboidAnnotation[source]#

field id: int#

field category_id: int#

field position: segments.typing.XYZ#

field dimensions: segments.typing.XYZ#

field yaw: float#

field rotation: Optional[segments.typing.XYZW]#

field type: typing_extensions.Literal[cuboid, cuboid-sync]#

field attributes: Optional[Dict[str, Optional[Union[str, bool]]]]#

Point cloud vector#

class PointcloudVectorLabelAttributes[source]#

field annotations: List[segments.typing.PointcloudVectorAnnotation]#

field format_version: Optional[Union[float, str]]#

class PointcloudVectorAnnotation[source]#

field id: int#

field category_id: int#

field points: List[List[float]]#

field type: typing_extensions.Literal[polygon, polyline, point]#

field attributes: Optional[Dict[str, Optional[Union[str, bool]]]]#

Point cloud sequence segmentation#

class PointcloudSequenceSegmentationLabelAttributes[source]#

field frames: List[segments.typing.PointcloudSegmentationFrame]#

field format_version: Optional[Union[float, str]]#

class PointcloudSegmentationFrame[source]#

field annotations: List[segments.typing.PointcloudSequenceSegmentationAnnotation]#

field point_annotations: Optional[List[int]]#

field timestamp: Optional[Union[str, int]]#

field format_version: Optional[Union[float, str]]#

class PointcloudSequenceSegmentationAnnotation[source]#

field id: int#

field category_id: int#

field track_id: int#

field is_keyframe: bool#

field attributes: Optional[Dict[str, Optional[Union[str, bool]]]]#

Point cloud sequence cuboid#

class PointcloudSequenceCuboidLabelAttributes[source]#

field frames: List[segments.typing.PointcloudSequenceCuboidFrame]#

field format_version: Optional[Union[float, str]]#

class PointcloudSequenceCuboidFrame[source]#

field annotations: List[segments.typing.PointcloudSequenceCuboidAnnotation]#

field timestamp: Optional[Union[str, int]]#

field format_version: Optional[Union[float, str]]#

class PointcloudSequenceCuboidAnnotation[source]#

Bases: PointcloudCuboidAnnotation

field track_id: int#

field is_keyframe: bool#

Point cloud sequence vector#

class PointcloudSequenceVectorLabelAttributes[source]#

field frames: List[segments.typing.PointcloudSequenceVectorFrame]#

field format_version: Optional[Union[float, str]]#

class PointcloudSequenceVectorFrame[source]#

field annotations: List[segments.typing.PointcloudSequenceVectorAnnotation]#

field format_version: Optional[Union[float, str]]#

field timestamp: Optional[Union[str, int]]#

class PointcloudSequenceVectorAnnotation[source]#

Bases: PointcloudVectorAnnotation

field track_id: int#

field is_keyframe: bool#

Text#

class TextLabelAttributes[source]#

field annotations: List[segments.typing.TextAnnotation]#

field format_version: Optional[Union[float, str]]#

class TextAnnotation[source]#

field start: int#

field end: int#

field category_id: int#

Labelsets#

class Labelset[source]#

field name: str#

field description: str#

field is_groundtruth: Optional[bool]#

field created_at: Optional[str]#

Releases#

class Release[source]#

field uuid: str#

field name: str#

field description: str#

field release_type: typing_extensions.Literal[JSON]#

field attributes: segments.typing.URL#

field status: typing_extensions.Literal[PENDING, SUCCEEDED, FAILED]#

field created_at: str#

field samples_count: int#

Files#

class File[source]#

field uuid: str#

field filename: str#

field url: str#

field created_at: str#

field presignedPostFields: segments.typing.PresignedPostFields#

Helper classes#

class URL[source]#

field url: Optional[str]#

class Owner[source]#

field username: str#

field created_at: str#

field email: Optional[str]#

class TaskAttributes[source]#

field format_version: Optional[Union[float, str]]#

field categories: Optional[List[segments.typing.TaskAttributeCategory]]#

field image_attributes: Optional[List[Union[segments.typing.SelectTaskAttribute, segments.typing.TextTaskAttribute, segments.typing.NumberTaskAttribute, segments.typing.CheckboxTaskAttribute]]]#

class TaskAttributeCategory[source]#

field name: str#

field id: int#

field color: Optional[Union[Tuple[int, int, int], Tuple[int, int, int, int]]]#

field has_instances: Optional[bool]#

field attributes: Optional[List[Union[segments.typing.SelectTaskAttribute, segments.typing.TextTaskAttribute, segments.typing.NumberTaskAttribute, segments.typing.CheckboxTaskAttribute]]]#

field dimensions: Optional[segments.typing.XYZ]#

class LabelStats[source]#

field TOTAL: Optional[int]#

field LABELED: Optional[int]#

field UNLABELED: Optional[int]#

field PRELABELED: Optional[int]#

class Statistics[source]#

field prelabeled_count: int#

field labeled_count: int#

field reviewed_count: int#

field rejected_count: int#

field skipped_count: int#

field samples_count: int#

class XYZ[source]#

field x: float#

field y: float#

field z: float#

class XYZW[source]#

field qx: float#

field qy: float#

field qz: float#

field qw: float#

class EgoPose[source]#

field position: segments.typing.XYZ#

field heading: segments.typing.XYZW#

class PCD[source]#

field url: str#

field type: typing_extensions.Literal[pcd, kitti, nuscenes]#

class CalibratedImage[source]#

Bases: URL

field row: int#

field col: int#

field intrinsics: Optional[segments.typing.CameraIntrinsics]#

field extrinsics: Optional[segments.typing.CameraExtrinsics]#

class CameraIntrinsics[source]#

field intrinsic_matrix: List[List[float]]#

class CameraExtrinsics[source]#

field translation: segments.typing.XYZ#

field rotation: segments.typing.XYZW#