FitParamSpec: FitParamSpec Class

In five-dots/ml4e: Machine Learning for Everyone

Description

A class defines the model fit parameter specification.

Usage

new_fit_param_spec(name = NULL, values = NULL, default = NULL, trans = NULL)

Arguments

name	A character scalar of parameter name.
values	A double, integer, character or logical vector of parameter values.
default	A default value. Must be a value within values.
trans	A trans class object from scales package.

Value

A new FitParamSpec class object

A new FitParamSpec class object.

Active bindings

name

A parameter name.

values

parameter values.

default

A default parameter value.

trans

A trans class object from sclaes package.

nlevels

A lenght of parameters.

type

A parameter type.

range

A parameter range.

has_default

A logical scalar wheather to have default value

trans_values

Translated values

trans_default

A translated default value

dials_param

A param object from dials package

Methods

Public methods

• FitParamSpec$new()

• FitParamSpec$print()

• FitParamSpec$get_dials_param()

• FitParamSpec$clone()

---

Method new()

Construct a new FitParamSpec class object.

Usage

FitParamSpec$new(name = NULL, values = NULL, default = NULL, trans = NULL)

Arguments

name

A character scalar of parameter name.

values

A double, integer, character or logical vector of parameter values.

default

A default value. Must be a value within values.

trans

A trans class object from scales package.

Returns

A new FitParamSpec class object

---

Method print()

Print object.

Usage

FitParamSpec$print()

---

Method get_dials_param()

Print object.

Usage

FitParamSpec$get_dials_param(quant_values = TRUE)

Arguments

quant_values

A logical scalar wheather to set fixed values.

Returns

A new dials class object.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FitParamSpec$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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