com.indeed.vw.wrapper.api.example

Class ExampleBuilder

java.lang.Object

com.indeed.vw.wrapper.api.example.ExampleBuilder

public class ExampleBuilder
extends Object

OOP wrapper for vowpal-wabbit input format.

Check https://github.com/JohnLangford/vowpal_wabbit/wiki/Input-format for format documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExampleBuilder.NamespaceBuilder Builder for namespace.

Method Summary

Modifier and Type	Method and Description
ExampleBuilder	binaryLabel(boolean binaryLabel) This is convenient method to set label when you use logistic or hinge loss you.
static ExampleBuilder	create() Create method
static ExampleBuilder	createAndDoNotCheckNamespace() By default each namespace should start with unique character.
ExampleBuilder.NamespaceBuilder	createNamespace(String namespace)
ExampleBuilder	exampleImportance(double exampleImportance) Importance (importance weight) is a non-negative real number indicating the relative importance
ExampleBuilder	exampleTag(String tag) Tag is a string that serves as an identifier for the example.
double	getLabelAsDouble() Get example label
String	getTag() Get example tag
ExampleBuilder	label(double label) Label is the real number that we are trying to predict for this example.
ExampleBuilder	omitLabel() If the label is omitted, then no training will be performed with the corresponding example,
ExampleBuilder	setLabelString(String label) You can use it to pass labels for multi-class classification.
String	toString() Build vowpal wabbit example string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static ExampleBuilder create()

Create method

Returns:

example builder

createAndDoNotCheckNamespace

public static ExampleBuilder createAndDoNotCheckNamespace()

By default each namespace should start with unique character.

If you want to have multiple namespaces starting with same character use this method.

Returns:

example builder

label

public ExampleBuilder label(double label)

Label is the real number that we are trying to predict for this example.

Important note: when using logistic or hinge loss, the labels need to be from the set {+1,-1}

Parameters:

label - example numerical label

Returns:

builder

binaryLabel

public ExampleBuilder binaryLabel(boolean binaryLabel)

This is convenient method to set label when you use logistic or hinge loss you.

This label will convert labels to be from the set {+1,-1}.

Parameters:

binaryLabel - example binary label

Returns:

builder

getLabelAsDouble

public double getLabelAsDouble()

Get example label

Returns:

label

getTag

public String getTag()

Get example tag

Returns:

tag

omitLabel

public ExampleBuilder omitLabel()

If the label is omitted, then no training will be performed with the corresponding example,

although VW will still compute a prediction.

Returns:

builder

setLabelString

public ExampleBuilder setLabelString(@Nonnull
                                     String label)

You can use it to pass labels for multi-class classification.

Parameters:

label - label

Returns:

builder

exampleTag

public ExampleBuilder exampleTag(@Nonnull
                                 String tag)

Tag is a string that serves as an identifier for the example.

It is reported back when predictions are made. It doesn't have to be unique.

The default value if it is not provided is the empty string.

Parameters:

tag - example tag

Returns:

builder

exampleImportance

public ExampleBuilder exampleImportance(double exampleImportance)

Importance (importance weight) is a non-negative real number indicating the relative importance

of this example over the others. Omitting this gives a default importance of 1 to the example.

Notice that you should pass -- invariant option in order to properly deal with example importance.

Parameters:

exampleImportance - example importance. Must be not negative

Returns:

builder

createNamespace

public ExampleBuilder.NamespaceBuilder createNamespace(@Nonnull
                                                       String namespace)

toString

public String toString()

Build vowpal wabbit example string

Overrides:

toString in class Object

Returns:

vowpal wabbit example string