GetWordCloud {datarobot}

Retrieve word cloud data for a model.

Description

Retrieve word cloud data for a model.

Usage

GetWordCloud(project, modelId, excludeStopWords = FALSE)

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.

excludeStopWords

logical. Optional. Set to TRUE if you want stopwords filtered out the response.

Value

data.frame with the following components:

ngram

character. word or ngram value

coefficient

numeric. value from [-1.0, 1.0] range, describes effect of this ngram on the target. A large negative value means a strong effect toward the negative class in classification projects and a smaller predicted target value in regression projects. A large positive value means a strong effect toward the positive class and a larger predicted target value respectively

frequency

numeric. value from (0.0, 1.0] range, frequency of this ngram relative to the most frequent ngram

count

integer. number of rows in the training sample where this ngram appears

isStopword

logical. true for ngrams that DataRobot evaluates as stopwords

variable

character. Optional. Added in DataRobot API 2.19. String representation of the ngram source. Contains the column name and, for some models, preprocessing details. For example, 'NGRAM_OCCUR_L2_cname' represents the ngram occurrences count using L2 normalization from the cname column

class

character. Optional. Added in DataRobot API 2.19. Values of the target class for the corresponding word or ngram. For regression, NA

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  GetWordCloud(projectId, modelId)

## End(Not run)