com.workfusion.vds.sdk.run.config

Class ClusterTrainingConfiguration.Builder

java.lang.Object

com.workfusion.vds.sdk.run.config.ClusterTrainingConfiguration.Builder

Enclosing class:

ClusterTrainingConfiguration

public static final class ClusterTrainingConfiguration.Builder
extends Object

Builder class used to build instance of ClusterTrainingConfiguration.

Method Summary

Modifier and Type	Method and Description
ClusterTrainingConfiguration	build() Build cluster (BEP) training configuration.
ClusterTrainingConfiguration.Builder	endpoint(String autoMlServiceEndpoint) Endpoint of autoMl service.
ClusterTrainingConfiguration.Builder	fields(List<com.workfusion.vds.sdk.api.nlp.configuration.FieldInfo> fields) Fields configuration for IE use-case.
ClusterTrainingConfiguration.Builder	id(String id) Training identifier, must be unique in scope of cluster.
ClusterTrainingConfiguration.Builder	inputDir(Path inputDir) Input dir path to folder with training set.
ClusterTrainingConfiguration.Builder	inputDir(String inputDir) Input dir path to folder with training set.
ClusterTrainingConfiguration.Builder	loadConfiguration(Path configurationFilePath) Loads configuration from file.
ClusterTrainingConfiguration.Builder	parameters(Map<String,Object> parameters) Training parameters.
ClusterTrainingConfiguration.Builder	resource(String dir, Path resourcePath) Adds additional resources to configuration like dictionaries, reference data, etc.
ClusterTrainingConfiguration.Builder	sharedWorkerDir(String sharedWorkerDir) Cluster shared worker dir.
ClusterTrainingConfiguration.Builder	sshHost(String host) Cluster master node host.
ClusterTrainingConfiguration.Builder	sshKey(String sshKey) Ssh key.
ClusterTrainingConfiguration.Builder	sshKeyPassphrase(String sshKeyPassphrase) Ssh key passphrase.
ClusterTrainingConfiguration.Builder	sshPort(int sshPort) Ssh port.
ClusterTrainingConfiguration.Builder	sshUsername(String sshUsername) Ssh username.
ClusterTrainingConfiguration.Builder	testSetDir(Path testSetDir) Path to directory with test set.
ClusterTrainingConfiguration.Builder	workingDir(String workingDir) Cluster working dir.

Methods inherited from class java.lang.Object

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

Method Detail

loadConfiguration

public ClusterTrainingConfiguration.Builder loadConfiguration(Path configurationFilePath)

Loads configuration from file.

Parameters:

configurationFilePath - path to properties file with configuration

Returns:

the builder

testSetDir

public ClusterTrainingConfiguration.Builder testSetDir(Path testSetDir)

Path to directory with test set.

Parameters:

testSetDir - the test set dir

Returns:

the builder

inputDir

public ClusterTrainingConfiguration.Builder inputDir(Path inputDir)

Input dir path to folder with training set.

Parameters:

inputDir - the input dir

Returns:

the builder

inputDir

public ClusterTrainingConfiguration.Builder inputDir(String inputDir)

Input dir path to folder with training set.

Parameters:

inputDir - the input dir string path

Returns:

the builder

parameters

public ClusterTrainingConfiguration.Builder parameters(Map<String,Object> parameters)

Training parameters.

Parameters:

parameters - the parameters

Returns:

the builder

fields

public ClusterTrainingConfiguration.Builder fields(List<com.workfusion.vds.sdk.api.nlp.configuration.FieldInfo> fields)

Fields configuration for IE use-case.

Parameters:

fields - the list of field info

Returns:

the builder

resource

public ClusterTrainingConfiguration.Builder resource(String dir,
                                                     Path resourcePath)

Adds additional resources to configuration like dictionaries, reference data, etc.

Parameters:

dir - to store inputs, relative to input dir

resourcePath - path to additional inputs

Returns:

the builder

id

public ClusterTrainingConfiguration.Builder id(String id)

Training identifier, must be unique in scope of cluster.

Parameters:

id - identifier of the training

Returns:

the builder

sshHost

public ClusterTrainingConfiguration.Builder sshHost(String host)

Cluster master node host.

Parameters:

host - the cluster host

Returns:

the builder

endpoint

public ClusterTrainingConfiguration.Builder endpoint(String autoMlServiceEndpoint)

Endpoint of autoMl service.

Parameters:

autoMlServiceEndpoint - the auto ml service endpoint

Returns:

the builder

sshPort

public ClusterTrainingConfiguration.Builder sshPort(int sshPort)

Ssh port. Default to 22.

Parameters:

sshPort - the ssh port

Returns:

the builder

sshUsername

public ClusterTrainingConfiguration.Builder sshUsername(String sshUsername)

Ssh username.

Parameters:

sshUsername - the auto ml ssh username

Returns:

the builder

sshKey

public ClusterTrainingConfiguration.Builder sshKey(String sshKey)

Ssh key.

Parameters:

sshKey - the ssh key

Returns:

the builder

sshKeyPassphrase

public ClusterTrainingConfiguration.Builder sshKeyPassphrase(String sshKeyPassphrase)

Ssh key passphrase.

Parameters:

sshKeyPassphrase - the ssh key passphrase

Returns:

the builder

workingDir

public ClusterTrainingConfiguration.Builder workingDir(String workingDir)

Cluster working dir.

Parameters:

workingDir - the working dir string path

Returns:

the builder

sharedWorkerDir

public ClusterTrainingConfiguration.Builder sharedWorkerDir(String sharedWorkerDir)

Cluster shared worker dir.

Parameters:

sharedWorkerDir - the cluster shared worker dir string path

Returns:

the builder

build

public ClusterTrainingConfiguration build()

Build cluster (BEP) training configuration.

Returns:

the BEP training configuration