summary.listOfDataRobotTuningParameters: Summarize the list of tuning parameters available for a...

View source: R/AdvancedTuning.R

summary.listOfDataRobotTuningParametersR Documentation

Summarize the list of tuning parameters available for a model.

Description

Summarize the list of tuning parameters available for a model.

Usage

## S3 method for class 'listOfDataRobotTuningParameters'
summary(object, ...)

Arguments

object

list. The list of tuning parameters to summarize.

...

list. Extra parameters that are ignored. Used to allow S3 inheritance to work.

Value

A data.frame detailing the following about each tuning parameter:

  • name character. The name of the tuning parameter.

  • current character. The current searched values of that parameter.

  • default character. The default value of that parameter.

  • constraint character. A short description of the possible values that parameter can take.

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  model <- GetModel(projectId, modelId)
  summary(GetTuningParameters(model))

## End(Not run)

datarobot documentation built on May 29, 2024, 4:36 a.m.