Breakthrough Model

albert.resources.btmodel

BTModelSessionCategory

Bases: str, Enum

Enumeration for BTModelSession categories.

Attributes:

Name	Type	Description
USER_MODEL
ALBERT_MODEL

USER_MODEL

USER_MODEL = 'userModel'

ALBERT_MODEL

ALBERT_MODEL = 'albertModel'

BTModelRegistry

Bases: BaseAlbertModel

Registry for BTModelSession.

Show JSON schema:

{
  "description": "Registry for BTModelSession.",
  "properties": {
    "BuildLogs": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Buildlogs"
    },
    "Metrics": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Metrics"
    }
  },
  "title": "BTModelRegistry",
  "type": "object"
}

Fields:

• build_logs (dict[str, Any] | None)
• metrics (dict[str, Any] | None)

build_logs

build_logs: dict[str, Any] | None = None

metrics

metrics: dict[str, Any] | None = None

BTModelSession

Bases: BaseResource

Parent session for a set of BTModels.

Attributes:

Name	Type	Description
name	str	The name of the model session.
category	BTModelSessionCategory	The category of the model session (e.g., userModel, albertModel).
id	BTModelSessionId | None	The unique identifier for the model session.
dataset_id	BTDatasetId	The identifier for the dataset associated with the model session.
default_model	str | None	The default model name for the session, if applicable.
total_time	str | None	The total time taken for the session, if applicable.
model_count	int | None	The number of models in the session, if applicable.
target	list[str] | None	The target variables for the models in the session, if applicable.
registry	BTModelRegistry | None	The registry containing build logs and metrics for the session, if applicable.
albert_model_details	dict[str, Any] | None	Details specific to the Albert model, if applicable.

name

name: str

category

category: BTModelSessionCategory

id

id: BTModelSessionId | None = Field(default=None)

dataset_id

dataset_id: BTDatasetId = Field(..., alias='datasetId')

default_model

default_model: str | None = Field(
    default=None, alias="defaultModel"
)

total_time

total_time: str | None = Field(
    default=None, alias="totalTime"
)

model_count

model_count: int | None = Field(
    default=None, alias="modelCount"
)

target

target: list[str] | None = Field(default=None)

registry

registry: BTModelRegistry | None = Field(
    default=None, alias="Registry"
)

albert_model_details

albert_model_details: dict[str, Any] | None = Field(
    default=None, alias="albertModelDetails"
)

flag

flag: bool = Field(default=False)

BTModelType

Bases: str, Enum

Enumeration for BTModel types.

Attributes:

Name	Type	Description
SESSION
DETACHED

SESSION

SESSION = 'Session'

DETACHED

DETACHED = 'Detached'

BTModelState

Bases: str, Enum

Enumeration for BTModel states.

Attributes:

Name	Type	Description
QUEUED
BUILDING_MODELS
GENERATING_CANDIDATES
COMPLETE
ERROR

QUEUED

QUEUED = 'Queued'

BUILDING_MODELS

BUILDING_MODELS = 'Building Models'

GENERATING_CANDIDATES

GENERATING_CANDIDATES = 'Generating Candidates'

COMPLETE

COMPLETE = 'Complete'

ERROR

ERROR = 'Error'

BTModel

Bases: BaseResource

A single Breakthrough model.

A BTModel may have a parent_id or be a detached, standalone model.

Attributes:

Name	Type	Description
name	str	The name of the model.
id	BTModelId | None	The unique identifier for the model.
dataset_id	BTDatasetId | None	The identifier for the dataset associated with the model.
parent_id	BTModelSessionId | None	The identifier for the parent model session, if applicable.
metadata	dict[str, Any] | None	Metadata associated with the model, if applicable.
type	BTModelType | None	The type of the model (e.g., Session, Detached).
state	BTModelState | None	The current state of the model (e.g., Queued, Building Models, Complete).
target	list[str] | None	The target variables for the model, if applicable.
start_time	str | None	The start time of the model creation, if applicable.
end_time	str | None	The end time of the model creation, if applicable.
total_time	str | None	The total time taken for the model creation, if applicable.
model_binary_key	str | None	The storage key for the model data, if applicable.

name

name: str

id

id: BTModelId | None = Field(default=None)

dataset_id

dataset_id: BTDatasetId | None = Field(
    default=None, alias="datasetId"
)

parent_id

parent_id: BTModelSessionId | None = Field(
    default=None, alias="parentId"
)

metadata

metadata: dict[str, Any] | None = Field(
    default=None, alias="Metadata"
)

type

type: BTModelType | None = Field(default=None)

state

state: BTModelState | None = Field(default=None)

target

target: list[str] | None = Field(default=None)

start_time

start_time: str | None = Field(
    default=None, alias="startTime"
)

end_time

end_time: str | None = Field(default=None, alias='endTime')

total_time

total_time: str | None = Field(
    default=None, alias="totalTime"
)

model_binary_key

model_binary_key: str | None = Field(
    default=None, alias="modelBinaryKey"
)

flag

flag: bool = Field(default=False)