tlc.schemas.values

Scalar value descriptors used by tlc.Schema.

This module defines the type-tagged value descriptors that a tlc.Schema attaches to leaf properties to describe their atomic type, range, role, and presentation. The user-facing subset is exposed via :data:__all__ – internal specializations (image / video / segmentation / object-type URL roles, RLE bytes) remain importable but are considered implementation details.

Module Contents

Classes

Class

Description

BoolValue

Describes a scalar boolean value

BytesStringValue

Describes a binary value utf-8 encoded as a string

DatetimeStringValue

Describes a date-time string value

DictValue

Describes a value which consists of an anonymous, free-form dictionary

DimensionNumericValue

Describes a scalar numeric value which is a dimension size within a property

Float32Value

A numeric value with type ‘float32’

Float64Value

A numeric value with type ‘float64’

FolderUrlStringValue

Describes a generic URL string value

ImageUrlStringValue

Describes a Image URL string value

InstanceSegmentationRleBytesStringValue

Describes a binary value encoded as a run-length encoding

Int16Value

A numeric value with type ‘int16’

Int32Value

A numeric value with type ‘int32’

Int64Value

A numeric value with type ‘int64’

Int8Value

A numeric value with type ‘int8’

NumericValue

Describes a scalar numeric value

ObjectTypeStringValue

A string containing an object type

ScalarValue

Describes a scalar value in a schema

SegmentationMaskUrlStringValue

Describes a Segmentation Mask URL string value

StringValue

Describes a string value

TensorUrlStringValue

Describes a URL string value pointing to a tensor

TimestampValue

A timestamp value counting the number of ‘unit’s since epoch

Uint16Value

A numeric value with type ‘uint16’

Uint32Value

A numeric value with type ‘uint32’

Uint64Value

A numeric value with type ‘uint64’

Uint8Value

A numeric value with type ‘uint8’

UrlStringValue

Describes a generic URL string value

VideoUrlStringValue

Describes a Video URL string value

API

class BoolValue(
default_value: bool | None = None,
)

Bases: tlc.schemas.values.ScalarValue

Describes a scalar boolean value

static from_any(
any_value: Any,
) → BoolValue

Create and populate a BoolValue object given an anonymous, potentially sparse object

class BytesStringValue(
default_value: str | None = None,
)

Bases: tlc.schemas.values.StringValue

Describes a binary value utf-8 encoded as a string

to_minimal_dict(
include_all: bool,
) → dict[str, Any]
class DatetimeStringValue(
default_value: str | None = None,
)

Bases: tlc.schemas.values.StringValue

Describes a date-time string value

class DictValue(
default_value: dict | None = None,
)

Bases: tlc.schemas.values.ScalarValue

Describes a value which consists of an anonymous, free-form dictionary

property default_value: dict
static from_any(
_: Any,
) → DictValue
class DimensionNumericValue(
value_min: int = 0,
value_max: int | None = None,
enforce_min: bool = True,
enforce_max: bool = False,
display_name: str = '',
description: str = '',
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
sample_type: str = '',
default_value: int | None = None,
)

Bases: tlc.schemas.values.Int32Value

Describes a scalar numeric value which is a dimension size within a property

static dimension_numeric_value_from_any(
this_property: Any,
) → DimensionNumericValue | None

Creates a DimensionNumericValue object and populates it from an anonymous, possibly sparse object

classmethod fixed_size(
size: int,
) → DimensionNumericValue

Create a fixed size dimension value

is_fixed_size() → bool
to_minimal_dict(
include_all: bool,
) → dict[str, Any]

Add a minimal representation of this object to a dictionary for subsequent serialization to JSON

class Float32Value(
value_min: float | None = None,
value_max: float | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
default_value: float | None = None,
)

Bases: tlc.schemas.values.NumericValue

A numeric value with type ‘float32’

class Float64Value(
value_min: float | None = None,
value_max: float | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
default_value: float | None = None,
)

Bases: tlc.schemas.values.NumericValue

A numeric value with type ‘float64’

class FolderUrlStringValue(
default_value: str | None = None,
)

Bases: tlc.schemas.values.StringValue

Describes a generic URL string value

class ImageUrlStringValue(
default_value: str | None = None,
)

Bases: tlc.schemas.values.UrlStringValue

Describes a Image URL string value

class InstanceSegmentationRleBytesStringValue(
polygons_are_relative: bool = False,
default_value: str | None = None,
)

Bases: tlc.schemas.values.BytesStringValue

Describes a binary value encoded as a run-length encoding

static from_any(
any_value: Any,
) → InstanceSegmentationRleBytesStringValue
to_minimal_dict(
include_all: bool,
) → dict[str, Any]
class Int16Value(
value_min: float | None = None,
value_max: float | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
default_value: int | None = None,
)

Bases: tlc.schemas.values.NumericValue

A numeric value with type ‘int16’

class Int32Value(
value_min: int | None = None,
value_max: int | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
default_value: int | None = None,
)

Bases: tlc.schemas.values.NumericValue

A numeric value with type ‘int32’

class Int64Value(
value_min: float | None = None,
value_max: float | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
default_value: int | None = None,
)

Bases: tlc.schemas.values.NumericValue

A numeric value with type ‘int64’

class Int8Value(
value_min: float | None = None,
value_max: float | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
default_value: int | None = None,
)

Bases: tlc.schemas.values.NumericValue

A numeric value with type ‘int8’

class NumericValue(
value_type: str = _DEFAULT_SCALAR_VALUE_TYPE,
value_min: float | int | None = None,
value_max: float | int | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
default_value: int | float | None = None,
)

Bases: tlc.schemas.values.ScalarValue

Describes a scalar numeric value

static from_any(
any_value: Any,
) → NumericValue

Create and populate a NumericValue object given an anonymous, potentially sparse object

static from_value(
value: Any,
) → NumericValue

Create a numeric value from a Python value.

Parameters:

value – The value to create a NumericValue from

Returns:

A NumericValue (or one it the derived classes) representing the value

to_minimal_dict(
include_all: bool,
) → dict[str, Any]

Add a minimal representation of this object to a dictionary for subsequent serialization to JSON

class ObjectTypeStringValue(
default_value: str | None = None,
)

Bases: tlc.schemas.values.StringValue

A string containing an object type

class ScalarValue(
value_type: str = _DEFAULT_SCALAR_VALUE_TYPE,
default_value: Any = None,
)

Describes a scalar value in a schema

property default_value: Any
static from_any(
any_value: Any,
) → ScalarValue

Create and populate a ScalarValue (or one of the derived classes) given an anonymous, potentially sparse object

static from_value(
value: Any,
) → ScalarValue

Create a scalar value from a Python value.

Parameters:

value – The value to create a ScalarValue from

Returns:

A ScalarValue (or one it the derived classes) representing the value

to_minimal_dict(
include_all: bool,
) → dict[str, Any]

Add a minimal representation of this object to a dictionary for subsequent serialization to JSON

class SegmentationMaskUrlStringValue(
default_value: str | None = None,
map: dict[float, MapElement] | dict[float, str] | None = None,
)

Bases: tlc.schemas.values.UrlStringValue

Describes a Segmentation Mask URL string value

static from_any(
any_value: Any,
) → SegmentationMaskUrlStringValue

Create and populate a SegmentationMaskUrlStringValue object given an anonymous, potentially sparse object

to_minimal_dict(
include_all: bool,
) → dict[str, Any]
class StringValue(
string_role: str = '',
default_value: str | None = None,
)

Bases: tlc.schemas.values.ScalarValue

Describes a string value

static from_any(
any_value: Any,
) → StringValue

Create and populate a StringValue object given an anonymous, potentially sparse object

to_minimal_dict(
include_all: bool,
) → dict[str, Any]

Add a minimal representation of this object to a dictionary for subsequent serialization to JSON

class TensorUrlStringValue(
default_value: str | None = None,
)

Bases: tlc.schemas.values.UrlStringValue

Describes a URL string value pointing to a tensor

class TimestampValue(
value_min: float | None = None,
value_max: float | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = NUMBER_ROLE_TIMESTAMP,
unit: str = 'ms',
value_map: dict[float, MapElement] | None = None,
default_value: int | None = None,
)

Bases: tlc.schemas.values.Int64Value

A timestamp value counting the number of ‘unit’s since epoch

Stores the value as an ‘int64’

Defaults to milliseconds resolution

class Uint16Value(
value_min: float | None = None,
value_max: float | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
default_value: int | None = None,
)

Bases: tlc.schemas.values.NumericValue

A numeric value with type ‘uint16’

class Uint32Value(
value_min: float | None = None,
value_max: float | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
default_value: int | None = None,
)

Bases: tlc.schemas.values.NumericValue

A numeric value with type ‘uint32’

class Uint64Value(
value_min: float | None = None,
value_max: float | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
default_value: int | None = None,
)

Bases: tlc.schemas.values.NumericValue

A numeric value with type ‘uint64’

class Uint8Value(
value_min: float | None = None,
value_max: float | None = None,
enforce_min: bool = False,
enforce_max: bool = False,
value_step: float = 0,
number_role: str = '',
unit: str = '',
value_map: dict[float, MapElement] | None = None,
default_value: int | None = None,
)

Bases: tlc.schemas.values.NumericValue

A numeric value with type ‘uint8’

class UrlStringValue(
url_string_icon: str = '',
default_value: str | None = None,
)

Bases: tlc.schemas.values.StringValue

Describes a generic URL string value

class VideoUrlStringValue(
default_value: str | None = None,
)

Bases: tlc.schemas.values.UrlStringValue

Describes a Video URL string value