org.apache.reef.examples.group.bgd.data

Interface Example

All Superinterfaces:

Serializable

All Known Implementing Classes:

SparseExample

public interface Example
extends Serializable

Base interface for Examples for linear models.

Method Summary

Methods

Modifier and Type	Method and Description
void	addGradient(Vector gradientVector, double gradient) Adds the current example's gradient to the gradientVector, assuming that the gradient with respect to the prediction is gradient.
double	getLabel() Access to the label.
double	predict(Vector w) Computes the prediction for this Example, given the model w.

Method Detail

getLabel

double getLabel()

Access to the label.

Returns:

the label

predict

double predict(Vector w)

Computes the prediction for this Example, given the model w.

w.dot(this.getFeatures())

Parameters:

w - the model

Returns:

the prediction for this Example, given the model w.

addGradient

void addGradient(Vector gradientVector,
               double gradient)

Adds the current example's gradient to the gradientVector, assuming that the gradient with respect to the prediction is gradient.