Blueprint
- class datarobot.models.Blueprint(id=None, processes=None, model_type=None, project_id=None, blueprint_category=None, monotonic_increasing_featurelist_id=None, monotonic_decreasing_featurelist_id=None, supports_monotonic_constraints=None, recommended_featurelist_id=None, supports_composable_ml=None, supports_incremental_learning=None)
A Blueprint which can be used to fit models
- Attributes:
- idstr
the id of the blueprint
- processeslist of str
the processes used by the blueprint
- model_typestr
the model produced by the blueprint
- project_idstr
the project the blueprint belongs to
- blueprint_categorystr
(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_mlbool or None
(New in version v2.26) whether this blueprint is supported in the Composable ML.
- supports_incremental_learningbool or None
(New in version v3.3) whether this blueprint supports incremental learning.
- classmethod get(project_id, blueprint_id)
Retrieve a blueprint.
- Parameters:
- project_idstr
The project’s id.
- blueprint_idstr
Id of blueprint to retrieve.
- Returns:
- blueprintBlueprint
The queried blueprint.
- Return type:
- get_json()
Get the blueprint json representation used by this model.
- Returns:
- BlueprintJson
Json representation of the blueprint stages.
- Return type:
Dict[str,Tuple[List[str],List[str],str]]
- get_chart()
Retrieve a chart.
- Returns:
- BlueprintChart
The current blueprint chart.
- Return type:
- get_documents()
Get documentation for tasks used in the blueprint.
- Returns:
- list of BlueprintTaskDocument
All documents available for blueprint.
- Return type:
List[BlueprintTaskDocument]
- classmethod from_data(data)
Instantiate an object of this class using a dict.
- Parameters:
- datadict
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:
- datadict
The directly translated dict of JSON from the server. No casing fixes have taken place
- keep_attrsiterable
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(title=None, task=None, description=None, parameters=None, links=None, references=None)
Document describing a task from a blueprint.
- Attributes:
- titlestr
Title of document.
- taskstr
Name of the task described in document.
- descriptionstr
Task description.
- parameterslist of dict(name, type, description)
Parameters that task can receive in human-readable format.
- linkslist of dict(name, url)
External links used in document
- referenceslist 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:
- nodeslist of dict (id, label)
Chart nodes, id unique in chart.
- edgeslist of tuple (id1, id2)
Directions of data flow between blueprint chart nodes.
- classmethod get(project_id, blueprint_id)
Retrieve a blueprint chart.
- Parameters:
- project_idstr
The project’s id.
- blueprint_idstr
Id of blueprint to retrieve chart.
- Returns:
- BlueprintChart
The queried blueprint chart.
- Return type:
- to_graphviz()
Get blueprint chart in graphviz DOT format.
- Returns:
- unicode
String representation of chart in graphviz DOT language.
- Return type:
str
- 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:
- nodeslist of dict (id, label)
Chart nodes, id unique in chart.
- edgeslist 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_idstr
The project’s id.
- model_idstr
Id of model to retrieve model blueprint chart.
- Returns:
- ModelBlueprintChart
The queried model blueprint chart.
- Return type:
- to_graphviz()
Get blueprint chart in graphviz DOT format.
- Returns:
- unicode
String representation of chart in graphviz DOT language.
- Return type:
str