Package com.gengoai.hermes.ml

Interface HStringMLModel

All Superinterfaces:

Copyable<Transform>, Function<HString,HString>, Model, Serializable, SerializableFunction<HString,HString>, Transform

All Known Implementing Classes:

BaseHStringMLModel, ElmoNERModel, ElmoSeq2SeqModel, ElmoTokenEmbedding, ENPOSTagger, EntityTagger, IOBTagger, NeuralNERModel, PhraseChunkTagger, POSTagger, TensorFlowSequenceLabeler, UniversalSentenceEncoder

public interface HStringMLModel
extends Model, SerializableFunction<HString,HString>

The interface H string ml model.

Method Summary

Modifier and Type	Method	Description
Model	delegate()	Delegate model.
default void	estimate(@NonNull DataSet dataset)
default void	estimate(@NonNull DocumentCollection documentCollection)	Estimate.
HStringDataSetGenerator	getDataGenerator()	Gets data generator.
default Evaluation	getEvaluator()
default FitParameters<?>	getFitParameters()
default Set<String>	getInputs()
default LabelType	getLabelType(@NonNull String name)
default String	getOutput()
default Set<String>	getOutputs()
String	getVersion()	Gets version.
void	setVersion(String version)	Sets version.
default DataSet	transform(@NonNull DataSet dataset)
default Datum	transform(@NonNull Datum datum)
default DataSet	transform(@NonNull DocumentCollection documentCollection)
default HString	transform(@NonNull HString hString)

Methods inherited from interface java.util.function.Function

andThen, apply, compose

Methods inherited from interface com.gengoai.apollo.ml.model.Model

copy, fitAndTransform, getLabelType, save

Methods inherited from interface com.gengoai.function.SerializableFunction

andThen, asConsumer, compose

Method Detail

delegate

Model delegate()

Delegate model.

Returns:

the model

estimate

default void estimate(@NonNull
                      @NonNull DocumentCollection documentCollection)

Estimate.

Parameters:

documentCollection - the document collection

estimate

default void estimate(@NonNull
                      @NonNull DataSet dataset)

Specified by:

estimate in interface Model

getDataGenerator

HStringDataSetGenerator getDataGenerator()

Gets data generator.

Returns:

the data generator

getEvaluator

default Evaluation getEvaluator()

getFitParameters

default FitParameters<?> getFitParameters()

Specified by:

getFitParameters in interface Model

getInputs

default Set<String> getInputs()

Specified by:

getInputs in interface Transform

getLabelType

default LabelType getLabelType(@NonNull
                               @NonNull String name)

Specified by:

getLabelType in interface Model

getOutput

default String getOutput()

getOutputs

default Set<String> getOutputs()

Specified by:

getOutputs in interface Transform

getVersion

String getVersion()

Gets version.

Returns:

the version

setVersion

void setVersion(String version)

Sets version.

Parameters:

version - the version

transform

default DataSet transform(@NonNull
                          @NonNull DocumentCollection documentCollection)

transform

default HString transform(@NonNull
                          @NonNull HString hString)

transform

default DataSet transform(@NonNull
                          @NonNull DataSet dataset)

Specified by:

transform in interface Transform

transform

default Datum transform(@NonNull
                        @NonNull Datum datum)

Specified by:

transform in interface Transform