modello (version 0.1.1)

module.softmax: R6 class representing a softmax regression model.

Description

R6 class representing a softmax regression model.

R6 class representing a softmax regression model.

Super classes

modello::module -> modello::module.lm -> module.softmax

Methods

Public methods

• module.softmax$new()

• module.softmax$op()

• module.softmax$clone()

• modello::module$j()

• modello::module$name()

• modello::module$npars()

• modello::module$save()

• modello::module$y()

• modello::module.lm$obj()

• modello::module.lm$pars()

Method new()

The initialisation method sets the weights (W), the bais (B) matrices, the objective function (obj), as well as the name of the module. The calculation performed is the following ans = softmax(W.op(X) + B)

Usage

module.softmax$new(tx, nin, nout, b = TRUE)

Arguments

tx

if TRUE it traspose the input matrix

nin

number of column of the input matrix

nout

number of outputs

b

if TRUE the intercept term is included

Returns

Returns the total number of parameters

Method op()

Performs: ans = sigmoid(W.op(X) + B)

Usage

module.softmax$op(X)

Arguments

X

input matrix, reference object of class 'number'

Returns

Returns a reference object of class 'number'

Examples

\donttest{
modello.init(10, 10, 10, 10)
X = number(matrix(rnorm(12), 6), dx=FALSE)
mdl = module.softmax$new(1, 2, 3, b=FALSE)
print(X$v)
Yh = mdl$op(X)
print(Yh)
print(Yh$v)
modello.close()
}

Method clone()

The objects of this class are cloneable with this method.

Usage

module.softmax$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# NOT RUN {
## ------------------------------------------------
## Method `module.softmax$op`
## ------------------------------------------------

# }
# NOT RUN {
modello.init(10, 10, 10, 10)
X = number(matrix(rnorm(12), 6), dx=FALSE)
mdl = module.softmax$new(1, 2, 3, b=FALSE)
print(X$v)
Yh = mdl$op(X)
print(Yh)
print(Yh$v)
modello.close()
# }