listOMLSetup: List hyperparameter settings

Description Usage Arguments Value Note See Also Examples

View source: R/listOMLSetup.R

Description

Each run has a setup.id, i.e. an ID for the hyperparameter settings of the flow that produced the run. This function allows the listing of hyperparameter settings.

Usage

1
2
listOMLSetup(setup.id = NULL, flow.id = NULL, limit = 1000,
  offset = NULL, verbosity = NULL)

Arguments

setup.id

[integer(1)]
ID of the setup (which is basically an ID for the parameter configuration).

flow.id

[integer(1)]
ID of the implementation of an OpenML flow.

limit

[numeric(1)]
Optional. The maximum number of entries to return. Without specifying offset, it returns the first 'limit' entries. Setting limit = NULL returns all available entries.

offset

[numeric(1)]
Optional. The offset to start from. Should be indices starting from 0, which do not refer to IDs. Is ignored when no limit is given.

verbosity

[integer(1)]
Print verbose output on console? Possible values are:
0: normal output,
1: info output,
2: debug output.
Default is set via setOMLConfig.

Value

[data.frame].

Note

This function is memoised. I.e., if you call this function twice in a running R session, the first call will query the server and store the results in memory while the second and all subsequent calls will return the cached results from the first call. You can reset the cache by calling forget on the function manually.

See Also

Other listing functions: chunkOMLlist, listOMLDataSetQualities, listOMLDataSets, listOMLEstimationProcedures, listOMLEvaluationMeasures, listOMLFlows, listOMLRuns, listOMLStudies, listOMLTaskTypes, listOMLTasks

Examples

1
2
3
# \dontrun{
#   listOMLSetup(limit = 1)
# }

openml/r documentation built on Nov. 23, 2018, 5:48 a.m.