org.datavec.api.transform

Class TransformProcess

java.lang.Object

org.datavec.api.transform.TransformProcess

All Implemented Interfaces:

Serializable

public class TransformProcess
extends Object
implements Serializable

A TransformProcess defines an ordered list of transformations to be executed on some data

Author:

Alex Black

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransformProcess.Builder Builder class for constructing a TransformProcess

Constructor Summary

Constructors

Constructor and Description
TransformProcess(Schema initialSchema, List<DataAction> actionList)

Method Summary

Modifier and Type	Method and Description
List<Writable>	execute(List<Writable> input) Execute the full sequence of transformations for a single example.
List<List<Writable>>	executeSequence(List<List<Writable>> inputSequence) Execute the full sequence of transformations for a single time series (sequence).
List<List<Writable>>	executeSequenceToSequence(List<List<Writable>> input)
static TransformProcess	fromJson(String json) Deserialize a JSON String (created by toJson()) to a TransformProcess
static TransformProcess	fromYaml(String yaml) Deserialize a JSON String (created by toJson()) to a TransformProcess
List<DataAction>	getActionList()
Schema	getFinalSchema() Get the Schema of the output data, after executing the process
Schema	getSchemaAfterStep(int step) Return the schema after executing all steps up to and including the specified step.
String	toJson() Convert the TransformProcess to a JSON string
String	toYaml() Convert the TransformProcess to a YAML string
List<Writable>	transformRawStringsToInput(String... values) Based on the input schema, map raw string values to the appropriate writable

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformProcess

public TransformProcess(Schema initialSchema,
                        List<DataAction> actionList)

Method Detail

getActionList

public List<DataAction> getActionList()

getFinalSchema

public Schema getFinalSchema()

Get the Schema of the output data, after executing the process

Returns:

Schema of the output data

getSchemaAfterStep

public Schema getSchemaAfterStep(int step)

Return the schema after executing all steps up to and including the specified step. Steps are indexed from 0: so getSchemaAfterStep(0) is after one transform has been executed.

Parameters:

step - Index of the step

Returns:

Schema of the data, after that (and all prior) steps have been executed

execute

public List<Writable> execute(List<Writable> input)

Execute the full sequence of transformations for a single example. May return null if example is filtered NOTE: Some TransformProcess operations cannot be done on examples individually. Most notably, ConvertToSequence and ConvertFromSequence operations require the full data set to be processed at once

Parameters:

input -

Returns:

executeSequenceToSequence

public List<List<Writable>> executeSequenceToSequence(List<List<Writable>> input)

Parameters:

input -

Returns:

executeSequence

public List<List<Writable>> executeSequence(List<List<Writable>> inputSequence)

Execute the full sequence of transformations for a single time series (sequence). May return null if example is filtered

toJson

public String toJson()

Convert the TransformProcess to a JSON string

Returns:

TransformProcess, as JSON

toYaml

public String toYaml()

Convert the TransformProcess to a YAML string

Returns:

TransformProcess, as YAML

fromJson

public static TransformProcess fromJson(String json)

Deserialize a JSON String (created by toJson()) to a TransformProcess

Returns:

TransformProcess, from JSON

fromYaml

public static TransformProcess fromYaml(String yaml)

Deserialize a JSON String (created by toJson()) to a TransformProcess

Returns:

TransformProcess, from JSON

transformRawStringsToInput

public List<Writable> transformRawStringsToInput(String... values)

Based on the input schema, map raw string values to the appropriate writable

Parameters:

values - the values to convert

Returns:

the transformed values based on the schema