GetTuningParameters: Retrieve data on tuning parameters for a particular model.

View source: R/AdvancedTuning.R

GetTuningParametersR Documentation

Retrieve data on tuning parameters for a particular model.

Description

Retrieve data on tuning parameters for a particular model.

Usage

GetTuningParameters(model)

Arguments

model

dataRobotModel. A DataRobot model object to get tuning parameters for.

Value

A list detailing the following about each tuning parameter:

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

  • defaultValue character. The default value of that parameter.

  • parameterId character. A unique ID for that particular parameter.

  • parameterName character. The name of the tuning parameter.

  • taskName character. The name of the task the parameter is for.

  • constraints list. A list describing constraints on the possible values for the parameter. Will be one of int or float specifying a min and max value, or will be select and will specify possible values from a list of choices. int and float correspond with integer and floating-point parameter spaces respectively. It is possible for a parameter to be multiple types. Lastly, some parameters will also have a supportsGridSearch logical for whether or not that parameter can be grid searched or not.

Examples

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

## End(Not run)

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