Package org.tribuo.hash

package org.tribuo.hash

Provides the base interface and implementations of the Model hashing which obscures the feature names stored in a model.

The base interface is Hasher, which has three implementations: HashCodeHasher which uses String.hashCode(), ModHashCodeHasher which uses String.hashCode() and remaps the output into a specific range, and MessageDigestHasher which uses a MessageDigest implementation to perform the hashing. Only MessageDigestHasher provides security guarantees suitable for production usage.

Note Hasher implementations require a salt which is serialized separately from the Hasher object. Without supplying this seed the hash methods will throw IllegalStateException.

Related Packages

Package	Description
org.tribuo	Provides the core interfaces and classes for using Tribuo.

Class	Description
HashCodeHasher	Hashes names using String.hashCode().
HashCodeHasher.HashCodeHasherProvenance	Provenance for the HashCodeHasher.
HashedFeatureMap	A FeatureMap used by the HashingTrainer to provide feature name hashing and guarantee that the Model does not contain feature name information, but still works with unhashed features names.
Hasher	An abstract base class for hash functions used to hash the names of features.
HashingOptions	An Options implementation which provides CLI arguments for the model hashing functionality.
HashingOptions.ModelHashingType	Supported types of hashes in CLI programs.
HashingTrainer<T extends Output<T>>	A Trainer which hashes the Dataset before the Model is produced.
MessageDigestHasher	Hashes Strings using the supplied MessageDigest type.
MessageDigestHasher.MessageDigestHasherProvenance	Provenance for MessageDigestHasher.
ModHashCodeHasher	Hashes names using String.hashCode(), then reduces the dimension.
ModHashCodeHasher.ModHashCodeHasherProvenance	Provenance for the ModHashCodeHasher.