org.tribuo.hash

Class HashingOptions

java.lang.Object

org.tribuo.hash.HashingOptions

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.config.Options

public class HashingOptions
extends Object
implements com.oracle.labs.mlrg.olcut.config.Options

An Options implementation which provides CLI arguments for the model hashing functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HashingOptions.ModelHashingType Supported types of hashes in CLI programs.

Field Summary

Fields

Modifier and Type	Field and Description
HashingOptions.ModelHashingType	modelHashingAlgorithm
String	modelHashingSalt

Fields inherited from interface com.oracle.labs.mlrg.olcut.config.Options

header

Constructor Summary

Constructors

Constructor and Description
HashingOptions()

Method Summary

Modifier and Type	Method and Description
<T extends Output<T>> Trainer<T>	getHashedTrainer(Trainer<T> innerTrainer) Gets the trainer wrapped in a hashing trainer.
Optional<Hasher>	getHasher() Get the specified hasher.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.labs.mlrg.olcut.config.Options

formatUsage, generateTypeDescription, getAllOptions, getOptionFields, getOptions, getOptionsDescription, getOptionUsage, getOptionUsage, getOptionUsage, getUsage

Field Detail

modelHashingAlgorithm

@Option(longName="model-hashing-algorithm",
        usage="Hash the model during training, options are {NONE,MOD,HC,SHA1,SHA256}")
public HashingOptions.ModelHashingType modelHashingAlgorithm

modelHashingSalt

@Option(longName="model-hashing-salt",
        usage="Salt for hashing the model")
public String modelHashingSalt

Constructor Detail

HashingOptions

public HashingOptions()

Method Detail

getHasher

public Optional<Hasher> getHasher()

Get the specified hasher.

Returns:

The configured hasher.

getHashedTrainer

public <T extends Output<T>> Trainer<T> getHashedTrainer(Trainer<T> innerTrainer)

Gets the trainer wrapped in a hashing trainer.

Type Parameters:

T - The output type.

Parameters:

innerTrainer - The inner trainer.

Returns:

The hashing trainer.