Blueprint

class datarobot.models.Blueprint

A Blueprint which can be used to fit models

Variables:

  • id (str) – the id of the blueprint

  • processes (List[str]) – the processes used by the blueprint

  • model_type (str) – the model produced by the blueprint

  • project_id (str) – the project the blueprint belongs to

  • blueprint_category (str) – (New in version v2.6) Describes the category of the blueprint and the kind of model it produces.

  • recommended_featurelist_id (str or null) – (New in v2.18) The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list.

  • supports_composable_ml (bool or None) – (New in version v2.26) whether this blueprint is supported in the Composable ML.

  • supports_incremental_learning (bool or None) – (New in version v3.3) whether this blueprint supports incremental learning.

classmethod get(project_id, blueprint_id)

Retrieve a blueprint.

Parameters:

  • project_id (str) – The project’s id.

  • blueprint_id (str) – Id of blueprint to retrieve.

Returns:

blueprint – The queried blueprint.

Return type:

Blueprint

get_json()

Get the blueprint json representation used by this model.

Returns:

Json representation of the blueprint stages.

Return type:

BlueprintJson

get_chart()

Retrieve a chart.

Returns:

The current blueprint chart.

Return type:

BlueprintChart

get_documents()

Get documentation for tasks used in the blueprint.

Returns:

All documents available for blueprint.

Return type:

list of BlueprintTaskDocument

classmethod from_data(data)

Instantiate an object of this class using a dict.

Parameters:

data (dict) – Correctly snake_cased keys and their values.

Return type:

TypeVar(T, bound= APIObject)

classmethod from_server_data(data, keep_attrs=None)

Instantiate an object of this class using the data directly from the server, meaning that the keys may have the wrong camel casing

Parameters:

  • data (dict) – The directly translated dict of JSON from the server. No casing fixes have taken place

  • keep_attrs (iterable) – List, set or tuple of the dotted namespace notations for attributes to keep within the object structure even if their values are None

Return type:

TypeVar(T, bound= APIObject)

class datarobot.models.BlueprintTaskDocument

Document describing a task from a blueprint.

Variables:

  • title (str) – Title of document.

  • task (str) – Name of the task described in document.

  • description (str) – Task description.

  • parameters (list of dict(name, type, description)) – Parameters that task can receive in human-readable format.

  • links (list of dict(name, url)) – External links used in document

  • references (list of dict(name, url)) – References used in document. When no link available url equals None.

class datarobot.models.BlueprintChart

A Blueprint chart that can be used to understand data flow in blueprint.

Variables:

  • nodes (list of dict (id, label)) – Chart nodes, id unique in chart.

  • edges (list of tuple (id1, id2)) – Directions of data flow between blueprint chart nodes.

classmethod get(project_id, blueprint_id)

Retrieve a blueprint chart.

Parameters:

  • project_id (str) – The project’s id.

  • blueprint_id (str) – Id of blueprint to retrieve chart.

Returns:

The queried blueprint chart.

Return type:

BlueprintChart

to_graphviz()

Get blueprint chart in graphviz DOT format.

Returns:

String representation of chart in graphviz DOT language.

Return type:

unicode

class datarobot.models.ModelBlueprintChart

A Blueprint chart that can be used to understand data flow in model. Model blueprint chart represents reduced repository blueprint chart with only elements that used to build this particular model.

Variables:

  • nodes (list of dict (id, label)) – Chart nodes, id unique in chart.

  • edges (list of tuple (id1, id2)) – Directions of data flow between blueprint chart nodes.

classmethod get(project_id, model_id)

Retrieve a model blueprint chart.

Parameters:

  • project_id (str) – The project’s id.

  • model_id (str) – Id of model to retrieve model blueprint chart.

Returns:

The queried model blueprint chart.

Return type:

ModelBlueprintChart

to_graphviz()

Get blueprint chart in graphviz DOT format.

Returns:

String representation of chart in graphviz DOT language.

Return type:

unicode