Breakthrough Model
Enumeration for BTModelSession categories.
Attributes:
| Name | Type | Description |
|---|---|---|
USER_MODEL |
|
|
ALBERT_MODEL |
|
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:
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. |
Show JSON schema:
{
"$defs": {
"AuditFields": {
"description": "The audit fields for a resource",
"properties": {
"by": {
"default": null,
"title": "By",
"type": "string"
},
"byName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Byname"
},
"at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "At"
}
},
"title": "AuditFields",
"type": "object"
},
"BTModelRegistry": {
"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"
},
"BTModelSessionCategory": {
"description": "Enumeration for BTModelSession categories.",
"enum": [
"userModel",
"albertModel"
],
"title": "BTModelSessionCategory",
"type": "string"
},
"Status": {
"description": "The status of a resource",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
}
},
"description": "Parent session for a set of BTModels.\n\nAttributes\n----------\nname : str\n The name of the model session.\ncategory : BTModelSessionCategory\n The category of the model session (e.g., userModel, albertModel).\nid : BTModelSessionId | None\n The unique identifier for the model session.\ndataset_id : BTDatasetId\n The identifier for the dataset associated with the model session.\ndefault_model : str | None\n The default model name for the session, if applicable.\ntotal_time : str | None\n The total time taken for the session, if applicable.\nmodel_count : int | None\n The number of models in the session, if applicable.\ntarget : list[str] | None\n The target variables for the models in the session, if applicable.\nregistry : BTModelRegistry | None\n The registry containing build logs and metrics for the session, if applicable.\nalbert_model_details : dict[str, Any] | None\n Details specific to the Albert model, if applicable.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"category": {
"$ref": "#/$defs/BTModelSessionCategory"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"datasetId": {
"title": "Datasetid",
"type": "string"
},
"defaultModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Defaultmodel"
},
"totalTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Totaltime"
},
"modelCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Modelcount"
},
"target": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
},
"Registry": {
"anyOf": [
{
"$ref": "#/$defs/BTModelRegistry"
},
{
"type": "null"
}
],
"default": null
},
"albertModelDetails": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertmodeldetails"
},
"flag": {
"default": false,
"title": "Flag",
"type": "boolean"
}
},
"required": [
"name",
"category",
"datasetId"
],
"title": "BTModelSession",
"type": "object"
}
Fields:
-
status(Status | None) -
created(AuditFields | None) -
updated(AuditFields | None) -
name(str) -
category(BTModelSessionCategory) -
id(BTModelSessionId | None) -
dataset_id(BTDatasetId) -
default_model(str | None) -
total_time(str | None) -
model_count(int | None) -
target(list[str] | None) -
registry(BTModelRegistry | None) -
albert_model_details(dict[str, Any] | None) -
flag(bool)
Enumeration for BTModel states.
Attributes:
| Name | Type | Description |
|---|---|---|
QUEUED |
|
|
BUILDING_MODELS |
|
|
GENERATING_CANDIDATES |
|
|
COMPLETE |
|
|
ERROR |
|
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. |
Show JSON schema:
{
"$defs": {
"AuditFields": {
"description": "The audit fields for a resource",
"properties": {
"by": {
"default": null,
"title": "By",
"type": "string"
},
"byName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Byname"
},
"at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "At"
}
},
"title": "AuditFields",
"type": "object"
},
"BTModelState": {
"description": "Enumeration for BTModel states.",
"enum": [
"Queued",
"Building Models",
"Generating Candidates",
"Complete",
"Error"
],
"title": "BTModelState",
"type": "string"
},
"BTModelType": {
"description": "Enumeration for BTModel types.",
"enum": [
"Session",
"Detached"
],
"title": "BTModelType",
"type": "string"
},
"Status": {
"description": "The status of a resource",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
}
},
"description": "A single Breakthrough model.\n\nA BTModel may have a `parent_id` or be a detached, standalone model.\n\nAttributes\n----------\nname : str\n The name of the model.\nid : BTModelId | None\n The unique identifier for the model.\ndataset_id : BTDatasetId | None\n The identifier for the dataset associated with the model.\nparent_id : BTModelSessionId | None\n The identifier for the parent model session, if applicable.\nmetadata : dict[str, Any] | None\n Metadata associated with the model, if applicable.\ntype : BTModelType | None\n The type of the model (e.g., Session, Detached).\nstate : BTModelState | None\n The current state of the model (e.g., Queued, Building Models, Complete).\ntarget : list[str] | None\n The target variables for the model, if applicable.\nstart_time : str | None\n The start time of the model creation, if applicable.\nend_time : str | None\n The end time of the model creation, if applicable.\ntotal_time : str | None\n The total time taken for the model creation, if applicable.\nmodel_binary_key : str | None\n The storage key for the model data, if applicable.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"datasetId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Datasetid"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parentid"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"type": {
"anyOf": [
{
"$ref": "#/$defs/BTModelType"
},
{
"type": "null"
}
],
"default": null
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/BTModelState"
},
{
"type": "null"
}
],
"default": null
},
"target": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
},
"startTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Starttime"
},
"endTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Endtime"
},
"totalTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Totaltime"
},
"modelBinaryKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Modelbinarykey"
},
"flag": {
"default": false,
"title": "Flag",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "BTModel",
"type": "object"
}
Fields:
-
status(Status | None) -
created(AuditFields | None) -
updated(AuditFields | None) -
name(str) -
id(BTModelId | None) -
dataset_id(BTDatasetId | None) -
parent_id(BTModelSessionId | None) -
metadata(dict[str, Any] | None) -
type(BTModelType | None) -
state(BTModelState | None) -
target(list[str] | None) -
start_time(str | None) -
end_time(str | None) -
total_time(str | None) -
model_binary_key(str | None) -
flag(bool)