Blueprint API

class datarobot.models.Blueprint(id=None, processes=None, model_type=None, project_id=None, blueprint_category=None)

A Blueprint which can be used to fit models

Attributes

id (str) the id of the blueprint
processes (list of 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.
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 : Blueprint

The queried blueprint.

get_chart()

Retrieve a chart.

Returns:

BlueprintChart

The current blueprint chart.

get_documents()

Get documentation for tasks used in the blueprint.

Returns:

list of BlueprintTaskDocument

All documents available for blueprint.

class datarobot.models.BlueprintTaskDocument(title=None, task=None, description=None, parameters=None, links=None, references=None)

Document describing a task from a blueprint.

Attributes

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(nodes, edges)

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

Attributes

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:

BlueprintChart

The queried blueprint chart.

to_graphviz()

Get blueprint chart in graphviz DOT format.

Returns:

unicode

String representation of chart in graphviz DOT language.

class datarobot.models.ModelBlueprintChart(nodes, edges)

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.

Attributes

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:

ModelBlueprintChart

The queried model blueprint chart.

to_graphviz()

Get blueprint chart in graphviz DOT format.

Returns:

unicode

String representation of chart in graphviz DOT language.