org.datavec.api.transform.sequence.split

Class SequenceSplitTimeSeparation

java.lang.Object

org.datavec.api.transform.sequence.split.SequenceSplitTimeSeparation

All Implemented Interfaces:

Serializable, SequenceSplit

public class SequenceSplitTimeSeparation
extends Object
implements SequenceSplit

Split a sequence into multiple sequences, based on the separation of time steps in a time column. For example, suppose we have a sequence with a gap of 1 day between two blocks of entries: we can use SequenceSplitTimeSeparation to split this data into two separate sequences. More generally, split the sequence any time the separation between consecutive time steps exceeds a specified value.

Author:

Alex Black

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SequenceSplitTimeSeparation(String timeColumn, long timeQuantity, TimeUnit timeUnit)

Method Summary

Modifier and Type	Method and Description
Schema	getInputSchema() Getter for the input schema
void	setInputSchema(Schema inputSchema) Sets the input schema for this split
List<List<List<Writable>>>	split(List<List<Writable>> sequence) Split a sequence in to multiple time steps
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceSplitTimeSeparation

public SequenceSplitTimeSeparation(String timeColumn,
                                   long timeQuantity,
                                   TimeUnit timeUnit)

Parameters:

timeColumn - Time column to consider when splitting

timeQuantity - Value/amount (of the specified TimeUnit)

timeUnit - The unit of time

Method Detail

split

public List<List<List<Writable>>> split(List<List<Writable>> sequence)

Description copied from interface: SequenceSplit

Split a sequence in to multiple time steps

Specified by:

split in interface SequenceSplit

Parameters:

sequence - the sequence to split

Returns:

setInputSchema

public void setInputSchema(Schema inputSchema)

Description copied from interface: SequenceSplit

Sets the input schema for this split

Specified by:

setInputSchema in interface SequenceSplit

Parameters:

inputSchema - the schema to set

getInputSchema

public Schema getInputSchema()

Description copied from interface: SequenceSplit

Getter for the input schema

Specified by:

getInputSchema in interface SequenceSplit

Returns:

toString

public String toString()

Overrides:

toString in class Object