datarobot (version 2.18.6)

GetModelBlueprintDocumentation: Get documentation for tasks used in the model blueprint

Description

A model blueprint is a "pruned down" blueprint representing what was actually run for the model. This is solely the branches of the blueprint that were executed based on the featurelist.

Usage

GetModelBlueprintDocumentation(project, modelId)

Value

list with following components

task

Character string name of the task described in document

description

Character string task description

title

Character string title of document

parameters

List of parameters that task can received in human-readable format with following components: name, type, description

links

List of external links used in document with following components: name, url

references

List of references used in document with following components: name, url

Arguments

project

character. Either (1) a character string giving the unique alphanumeric identifier for the project, or (2) a list containing the element projectId with this identifier.

modelId

character. Unique alphanumeric identifier for the model of interest.

Examples

if (FALSE) {
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  GetModelBlueprintDocumentation(projectId, modelId)
}