GetRulesets: List the rulesets approximating a model generated by...

View source: R/GetRulesets.R

GetRulesetsR Documentation

List the rulesets approximating a model generated by DataRobot Prime

Description

This function will return list of rulesets that could be used to approximate the specified model. Rulesets are created using the RequestApproximation function. If model hasn't been approximated yet, will return empty list

Usage

GetRulesets(project, modelId)

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

Unique alphanumeric identifier for the model of interest.

Value

A list of lists with one element for each ruleset. If there are no rulesets created for a model then an empty list is returned If the group is not empty,a list is returned with the following elements:

  • projectId. Character string giving the unique identifier for the project.

  • rulesetId. Integer number giving the identifier for the ruleset.

  • score. Score of ruleset (using project leaderboard metric).

  • parentModelId. Character string giving the unique identifier for the parent model.

  • ruleCount. integer: number of rules in ruleset.

  • modelId. Character string giving the unique identifier for a model using the ruleset. May be NULL if no model using the ruleset has been created yet.

Examples

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

## End(Not run)

datarobot documentation built on Nov. 3, 2023, 1:07 a.m.