org.datavec.api.records.reader.impl.csv

Class CSVNLinesSequenceRecordReader

java.lang.Object

org.datavec.api.records.reader.BaseRecordReader

org.datavec.api.records.reader.impl.LineRecordReader

org.datavec.api.records.reader.impl.csv.CSVRecordReader

org.datavec.api.records.reader.impl.csv.CSVNLinesSequenceRecordReader

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Configurable, RecordReader, SequenceRecordReader

public class CSVNLinesSequenceRecordReader
extends CSVRecordReader
implements SequenceRecordReader

A CSV Sequence record reader where:
(a) all time series are in a single file
(b) each time series is of the same length (specified in constructor)
(c) no delimiter is used between time series
For example, with nLinesPerSequence=10, lines 0 to 9 are the first time series, 10 to 19 are the second, and so on.

Author:

Alex Black

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	LINES_PER_SEQUENCE

Fields inherited from class org.datavec.api.records.reader.impl.csv.CSVRecordReader

DEFAULT_DELIMITER, DEFAULT_QUOTE, DELIMITER, QUOTE, SKIP_NUM_LINES, skipNumLines

Fields inherited from class org.datavec.api.records.reader.impl.LineRecordReader

charset, conf, initialized, lineIndex, locations, splitIndex

Fields inherited from class org.datavec.api.records.reader.BaseRecordReader

inputSplit, listeners, streamCreatorFn

Fields inherited from interface org.datavec.api.records.reader.RecordReader

APPEND_LABEL, LABELS, NAME_SPACE

Constructor Summary

Constructors

Constructor and Description
CSVNLinesSequenceRecordReader() No-arg constructor with the default number of lines per sequence (10)
CSVNLinesSequenceRecordReader(int nLinesPerSequence)
CSVNLinesSequenceRecordReader(int nLinesPerSequence, int skipNumLines, String delimiter)

Method Summary

Modifier and Type	Method and Description
void	initialize(Configuration conf, InputSplit split) Called once at initialization.
List<Record>	loadFromMetaData(List<RecordMetaData> recordMetaDatas) Load multiple records from the given a list of RecordMetaData instances
Record	loadFromMetaData(RecordMetaData recordMetaData) Load a single record from the given RecordMetaData instance Note: that for data that isn't splittable (i.e., text data that needs to be scanned/split), it is more efficient to load multiple records at once using RecordReader.loadFromMetaData(List)
List<SequenceRecord>	loadSequenceFromMetaData(List<RecordMetaData> recordMetaDatas) Load multiple sequence records from the given a list of RecordMetaData instances
SequenceRecord	loadSequenceFromMetaData(RecordMetaData recordMetaData) Load a single sequence record from the given RecordMetaData instance Note: that for data that isn't splittable (i.e., text data that needs to be scanned/split), it is more efficient to load multiple records at once using SequenceRecordReader.loadSequenceFromMetaData(List)
SequenceRecord	nextSequence() Similar to SequenceRecordReader.sequenceRecord(), but returns a Record object, that may include metadata such as the source of the data
List<List<Writable>>	sequenceRecord() Returns a sequence record.
List<List<Writable>>	sequenceRecord(URI uri, DataInputStream dataInputStream) Load a sequence record from the given DataInputStream Unlike RecordReader.next() the internal state of the RecordReader is not modified Implementations of this method should not close the DataInputStream

Methods inherited from class org.datavec.api.records.reader.impl.csv.CSVRecordReader

batchesSupported, hasNext, next, next, nextRecord, onLocationOpen, parseLine, readStringLine, record, reset

Methods inherited from class org.datavec.api.records.reader.impl.LineRecordReader

close, closeIfRequired, getConf, getIterator, getLabels, initialize, resetSupported, setConf

Methods inherited from class org.datavec.api.records.reader.BaseRecordReader

getListeners, invokeListeners, setListeners, setListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.datavec.api.records.reader.RecordReader

batchesSupported, getLabels, getListeners, hasNext, initialize, next, next, nextRecord, record, reset, resetSupported, setListeners, setListeners

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.datavec.api.conf.Configurable

getConf, setConf

Field Detail

LINES_PER_SEQUENCE

public static final String LINES_PER_SEQUENCE

Constructor Detail

CSVNLinesSequenceRecordReader

public CSVNLinesSequenceRecordReader()

No-arg constructor with the default number of lines per sequence (10)

CSVNLinesSequenceRecordReader

public CSVNLinesSequenceRecordReader(int nLinesPerSequence)

Parameters:

nLinesPerSequence - Number of lines in each sequence, use default delemiter(,) between entries in the same line

CSVNLinesSequenceRecordReader

public CSVNLinesSequenceRecordReader(int nLinesPerSequence,
                                     int skipNumLines,
                                     String delimiter)

Parameters:

nLinesPerSequence - Number of lines in each sequences

skipNumLines - Number of lines to skip at the start of the file (only skipped once, not per sequence)

delimiter - Delimiter between entries in the same line, for example ","

Method Detail

initialize

public void initialize(Configuration conf,
                       InputSplit split)
                throws IOException,
                       InterruptedException

Description copied from interface: RecordReader

Called once at initialization.

Specified by:

initialize in interface RecordReader

Overrides:

initialize in class CSVRecordReader

Parameters:

conf - a configuration for initialization

split - the split that defines the range of records to read

Throws:

IOException

InterruptedException

sequenceRecord

public List<List<Writable>> sequenceRecord()

Description copied from interface: SequenceRecordReader

Returns a sequence record.

Specified by:

sequenceRecord in interface SequenceRecordReader

Returns:

a sequence of records

sequenceRecord

public List<List<Writable>> sequenceRecord(URI uri,
                                           DataInputStream dataInputStream)
                                    throws IOException

Description copied from interface: SequenceRecordReader

Load a sequence record from the given DataInputStream Unlike RecordReader.next() the internal state of the RecordReader is not modified Implementations of this method should not close the DataInputStream

Specified by:

sequenceRecord in interface SequenceRecordReader

Throws:

IOException - if error occurs during reading from the input stream

nextSequence

public SequenceRecord nextSequence()

Description copied from interface: SequenceRecordReader

Similar to SequenceRecordReader.sequenceRecord(), but returns a Record object, that may include metadata such as the source of the data

Specified by:

nextSequence in interface SequenceRecordReader

Returns:

next sequence record

loadSequenceFromMetaData

public SequenceRecord loadSequenceFromMetaData(RecordMetaData recordMetaData)
                                        throws IOException

Description copied from interface: SequenceRecordReader

Load a single sequence record from the given RecordMetaData instance
Note: that for data that isn't splittable (i.e., text data that needs to be scanned/split), it is more efficient to load multiple records at once using SequenceRecordReader.loadSequenceFromMetaData(List)

Specified by:

loadSequenceFromMetaData in interface SequenceRecordReader

Parameters:

recordMetaData - Metadata for the sequence record that we want to load from

Returns:

Single sequence record for the given RecordMetaData instance

Throws:

IOException - If I/O error occurs during loading

loadSequenceFromMetaData

public List<SequenceRecord> loadSequenceFromMetaData(List<RecordMetaData> recordMetaDatas)
                                              throws IOException

Description copied from interface: SequenceRecordReader

Load multiple sequence records from the given a list of RecordMetaData instances

Specified by:

loadSequenceFromMetaData in interface SequenceRecordReader

Parameters:

recordMetaDatas - Metadata for the records that we want to load from

Returns:

Multiple sequence record for the given RecordMetaData instances

Throws:

IOException - If I/O error occurs during loading

loadFromMetaData

public Record loadFromMetaData(RecordMetaData recordMetaData)

Description copied from interface: RecordReader

Load a single record from the given RecordMetaData instance
Note: that for data that isn't splittable (i.e., text data that needs to be scanned/split), it is more efficient to load multiple records at once using RecordReader.loadFromMetaData(List)

Specified by:

loadFromMetaData in interface RecordReader

Overrides:

loadFromMetaData in class CSVRecordReader

Parameters:

recordMetaData - Metadata for the record that we want to load from

Returns:

Single record for the given RecordMetaData instance

loadFromMetaData

public List<Record> loadFromMetaData(List<RecordMetaData> recordMetaDatas)

Description copied from interface: RecordReader

Load multiple records from the given a list of RecordMetaData instances

Specified by:

loadFromMetaData in interface RecordReader

Overrides:

loadFromMetaData in class CSVRecordReader

Parameters:

recordMetaDatas - Metadata for the records that we want to load from

Returns:

Multiple records for the given RecordMetaData instances