tlc.core.builtins.schemas.schemas#

A number of helper classes for common simple schemas

Module Contents#

Classes#

Class

Description

XyzSchema

A Schema defining an (x, y, z) value

COCOLabelSchema

A Schema defining COCO label

CIFAR10LabelSchema

A Schema defining CIFAR10 label

CategoricalLabelSchema

A schema for a categorical label

FloatVector2Schema

A schema for a 2D vector

FloatVector3Schema

A schema for a 3D vector

ExampleIdSchema

A schema for example ID values

EpochSchema

A schema for epoch values

IterationSchema

A schema for iteration values

ForeignTableIdSchema

A schema describing a value that identifies a foreign table

SampleWeightSchema

A schema for sample weight values

API#

class tlc.core.builtins.schemas.schemas.XyzSchema(display_name: str = '', description: str = '', writable: bool = True, display_importance: float = 0, value_type: str = _DEFAULT_SCALAR_VALUE)#

Bases: tlc.core.schema.Schema

A Schema defining an (x, y, z) value

class tlc.core.builtins.schemas.schemas.COCOLabelSchema(display_name: str = 'label', description: str = 'COCO Label', writable: bool = False, display_importance: float = 0)#

Bases: tlc.core.schema.Schema

A Schema defining COCO label

class tlc.core.builtins.schemas.schemas.CIFAR10LabelSchema(display_name: str = 'label', description: str = 'CIFAR-10 Label', writable: bool = False, display_importance: float = 0, value_type: str = _DEFAULT_SCALAR_VALUE)#

Bases: tlc.core.schema.Schema

A Schema defining CIFAR10 label

class tlc.core.builtins.schemas.schemas.CategoricalLabelSchema(class_names: list[str], display_name: str = 'label', description: str = '', writable: bool = False, display_colors: list[str] | None = None, display_importance: float = 0)#

Bases: tlc.core.schema.Schema

A schema for a categorical label

class tlc.core.builtins.schemas.schemas.FloatVector2Schema(display_name: str = '2D Embedding', description: str = '', writable: bool = False, display_importance: float = 0)#

Bases: tlc.core.schema.Schema

A schema for a 2D vector

class tlc.core.builtins.schemas.schemas.FloatVector3Schema(display_name: str = '3D Embedding', description: str = '', writable: bool = False, display_importance: float = 0)#

Bases: tlc.core.schema.Schema

A schema for a 3D vector

class tlc.core.builtins.schemas.schemas.ExampleIdSchema(display_name: str = 'Example ID', description: str = '', writable: bool = False, computable: bool = False)#

Bases: tlc.core.schema.Schema

A schema for example ID values

Example ID is a unique identifier for an example. It is used to identify examples across different tables.

class tlc.core.builtins.schemas.schemas.EpochSchema(display_name: str = 'Epoch', description: str = 'Epoch of training', display_importance: float | None = None)#

Bases: tlc.core.schema.Schema

A schema for epoch values

class tlc.core.builtins.schemas.schemas.IterationSchema(display_name: str = 'Iteration', description: str = 'The current iteration of the training process.', display_importance: float | None = None)#

Bases: tlc.core.schema.Schema

A schema for iteration values

class tlc.core.builtins.schemas.schemas.ForeignTableIdSchema(foreign_table_url: str, display_name: str)#

Bases: tlc.core.schema.Schema

A schema describing a value that identifies a foreign table

class tlc.core.builtins.schemas.schemas.SampleWeightSchema(display_name: str = 'Weight', description: str = 'The weights of the samples in this table.', sample_type: str = 'hidden', default_value: float = 1.0)#

Bases: tlc.core.schema.Schema

A schema for sample weight values

Initialize the SampleWeightSchema

Parameters:
  • display_name – The display name of the schema

  • description – The description of the schema

  • sample_type – The sample type of the schema

  • default_value – The default value of the schema