Breakthrough Datasets
Bases: BaseAlbertModel
The Albert entities a Breakthrough dataset was assembled from.
Records which projects, data columns, targets, and worksheets contributed the
data in a BTDataset, plus any filter applied when the data was pulled.
Show JSON schema:
{
"description": "The Albert entities a Breakthrough dataset was assembled from.\n\nRecords which projects, data columns, targets, and worksheets contributed the\ndata in a [`BTDataset`][albert.resources.btdataset.BTDataset], plus any filter applied when the data was pulled.",
"properties": {
"project_ids": {
"description": "Identifiers of the projects the data was drawn from (format ``PRO...``).",
"items": {
"type": "string"
},
"title": "Project Ids",
"type": "array"
},
"data_column_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifiers of the data columns included (format ``DAC...``).",
"title": "Data Column Ids"
},
"target_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifiers of the targets included (format ``TAR...``).",
"title": "Target Ids"
},
"sheet_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifiers of the worksheets the data was drawn from (format ``WKS...``).",
"title": "Sheet Ids"
},
"filter": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Free-form filter criteria applied when assembling the data.",
"title": "Filter"
}
},
"required": [
"project_ids"
],
"title": "BTDatasetReferences",
"type": "object"
}
Fields:
-
project_ids(list[str]) -
data_column_ids(list[str] | None) -
target_ids(list[str] | None) -
sheet_ids(list[str] | None) -
filter(dict[str, Any] | None)
Identifiers of the projects the data was drawn from (format PRO...).
Identifiers of the data columns included (format DAC...).
Identifiers of the worksheets the data was drawn from (format WKS...).
Bases: BaseResource
A dataset used to build and train Breakthrough models.
Albert Breakthrough is Albert's inverse-design / ML optimization capability. A dataset holds the tabular
data that Breakthrough model sessions and models
(BTModelSession,
BTModel) are trained on; their dataset_id
points back to a dataset. Datasets are managed through
BTDatasetCollection.
A BTDataset and a SmartDataset are
distinct entities that share an ETL engine (Zeus stored procedures) but are not
interchangeable: a BTDataset is a Breakthrough pointer record (its dataset
rows are stored in S3), while a SmartDataset is a Smart Projects entity. A
SmartDataset is not itself an input to Albert Breakthrough.
Example
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"
},
"BTDatasetReferences": {
"description": "The Albert entities a Breakthrough dataset was assembled from.\n\nRecords which projects, data columns, targets, and worksheets contributed the\ndata in a [`BTDataset`][albert.resources.btdataset.BTDataset], plus any filter applied when the data was pulled.",
"properties": {
"project_ids": {
"description": "Identifiers of the projects the data was drawn from (format ``PRO...``).",
"items": {
"type": "string"
},
"title": "Project Ids",
"type": "array"
},
"data_column_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifiers of the data columns included (format ``DAC...``).",
"title": "Data Column Ids"
},
"target_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifiers of the targets included (format ``TAR...``).",
"title": "Target Ids"
},
"sheet_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifiers of the worksheets the data was drawn from (format ``WKS...``).",
"title": "Sheet Ids"
},
"filter": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Free-form filter criteria applied when assembling the data.",
"title": "Filter"
}
},
"required": [
"project_ids"
],
"title": "BTDatasetReferences",
"type": "object"
},
"EntityLink": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
}
},
"required": [
"id"
],
"title": "EntityLink",
"type": "object"
},
"Status": {
"description": "The status of a resource.\n\nAttributes\n----------\nACTIVE : str\n The resource is fully operational and visible in normal operations.\nINACTIVE : str\n The resource is hidden from normal operations and disabled from use.",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
}
},
"description": "A dataset used to build and train Breakthrough models.\n\nAlbert Breakthrough is Albert's inverse-design / ML optimization capability. A dataset holds the tabular\ndata that Breakthrough model sessions and models\n([`BTModelSession`][albert.resources.btmodel.BTModelSession],\n[`BTModel`][albert.resources.btmodel.BTModel]) are trained on; their ``dataset_id``\npoints back to a dataset. Datasets are managed through\n[`BTDatasetCollection`][albert.collections.btdataset.BTDatasetCollection].\n\nA ``BTDataset`` and a [`SmartDataset`][albert.resources.smart_datasets.SmartDataset] are\ndistinct entities that share an ETL engine (Zeus stored procedures) but are not\ninterchangeable: a ``BTDataset`` is a Breakthrough pointer record (its dataset\nrows are stored in S3), while a ``SmartDataset`` is a Smart Projects entity. A\nSmartDataset is not itself an input to Albert Breakthrough.\n\n!!! example\n ```python\n from albert.resources.btdataset import BTDataset\n\n dataset = BTDataset(name=\"Coatings training set\")\n ```",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null,
"description": "The status of the resource, optional."
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null,
"description": "Audit fields for the creation of the resource, optional."
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null,
"description": "Audit fields for the update of the resource, optional."
},
"name": {
"description": "Human-readable name of the dataset.",
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Unique identifier of the dataset (format ``DST...``). Assigned by Albert on creation.",
"title": "Albertid"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of the project the dataset belongs to (format ``PRO...``).",
"title": "Parentid"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Storage key for the dataset's underlying data file, if applicable.",
"title": "Key"
},
"fileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the dataset's underlying data file, if applicable.",
"title": "Filename"
},
"Report": {
"anyOf": [
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"description": "Link to a related report, if any."
},
"References": {
"anyOf": [
{
"$ref": "#/$defs/BTDatasetReferences"
},
{
"type": "null"
}
],
"default": null,
"description": "The Albert entities the dataset was assembled from."
}
},
"required": [
"name"
],
"title": "BTDataset",
"type": "object"
}
Fields:
-
status(Status | None) -
created(AuditFields | None) -
updated(AuditFields | None) -
name(str) -
id(BTDatasetId | None) -
parent_id(ProjectId | None) -
key(str | None) -
file_name(str | None) -
report(EntityLink | None) -
references(BTDatasetReferences | None)
id: BTDatasetId | None = None
Unique identifier of the dataset (format DST...). Assigned by Albert on creation.
parent_id: ProjectId | None = None
Identifier of the project the dataset belongs to (format PRO...).
references: BTDatasetReferences | None = None
The Albert entities the dataset was assembled from.