FitParamSpecs: FitParamSpecs Class

Description Usage Arguments Value Super classes Active bindings Methods

Description

Key-value dictionary contains FitParamSpec class objects. This class is passed to Model class and defines parameters of model's fit functon.

Usage

1

Arguments

...

Key and value pairs.

Value

A new FitParamSpecs class object.

Super classes

Dict::Dict -> ml4e::Option -> FitParamSpecs

Active bindings

defaults

A list of default values

Methods

Public methods

Inherited methods

Method new()

Construct a new FitParamSpecs class object.

Usage
FitParamSpecs$new(...)
Arguments
...

Key and value pairs.

Returns

A new FitParamSpecs class object


Method add()

Adds key-value objects to the dictionary.

Usage
FitParamSpecs$add(...)
Arguments
...

Key and value pairs.


Method print()

Print object.

Usage
FitParamSpecs$print()

Method get_grid()

Get paramter grid.

Usage
FitParamSpecs$get_grid()
Returns

A data.frame of parameter grid.


Method get_random()

Get random paramter grid.

Usage
FitParamSpecs$get_random(size = NULL)
Arguments
size

A integer scalar of parameter size.

Returns

A data.frame of parameter grid.


Method get_bayes_info()

Get information for BayesianSearch.

Usage
FitParamSpecs$get_bayes_info()
Returns

A list of parameter infomation.


Method clone()

The objects of this class are cloneable with this method.

Usage
FitParamSpecs$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


five-dots/ml4e documentation built on June 19, 2020, 4:26 p.m.