org.datavec.api.records.reader.impl.filebatch

Class FileBatchRecordReader

java.lang.Object

org.datavec.api.records.reader.impl.filebatch.FileBatchRecordReader

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Configurable, RecordReader

public class FileBatchRecordReader
extends Object
implements RecordReader

FileBatchRecordReader reads the files contained in a FileBatch using the specified RecordReader.
Specifically, the RecordReader.record(URI, DataInputStream) method of the underlying reader is used to load files.
For example, if the FileBatch was constructed using image files (png, jpg etc), FileBatchRecordReader could be used with ImageRecordReader. For example:

 
 List<File> imgFiles = ...;
 FileBatch fb = FileBatch.forFiles(imgFiles);
 PathLabelGenerator labelMaker = new ParentPathLabelGenerator();
 ImageRecordReader rr = new ImageRecordReader(32, 32, 1, labelMaker);
 rr.setLabels(Arrays.asList("class0", "class1"));
 FileBatchRecordReader fbrr = new FileBatchRecordReader(rr, fb);
 
 

Author:

Alex Black

See Also:

Serialized Form

Field Summary

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

APPEND_LABEL, LABELS, NAME_SPACE

Constructor Summary

Constructors

Constructor and Description
FileBatchRecordReader(RecordReader rr, FileBatch fileBatch)

Method Summary

Modifier and Type	Method and Description
boolean	batchesSupported() This method returns true, if next(int) signature is supported by this RecordReader implementation.
void	close()
Configuration	getConf() Return the configuration used by this object.
List<String>	getLabels() List of label strings
List<RecordListener>	getListeners() Get the record listeners for this record reader.
boolean	hasNext() Whether there are anymore records
void	initialize(Configuration conf, InputSplit split) Called once at initialization.
void	initialize(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<Writable>	next() Get the next record
List<List<Writable>>	next(int num) This method will be used, if batchesSupported() returns true.
Record	nextRecord() Similar to RecordReader.next(), but returns a Record object, that may include metadata such as the source of the data
List<Writable>	record(URI uri, DataInputStream dataInputStream) Load the 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
void	reset() Reset record reader iterator
boolean	resetSupported()
void	setConf(Configuration conf) Set the configuration to be used by this object.
void	setListeners(Collection<RecordListener> listeners) Set the record listeners for this record reader.
void	setListeners(RecordListener... listeners) Set the record listeners for this record reader.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBatchRecordReader

public FileBatchRecordReader(RecordReader rr,
                             FileBatch fileBatch)

Parameters:

rr - Underlying record reader to read files from

fileBatch - File batch to read files from

Method Detail

initialize

public void initialize(InputSplit split)
                throws IOException,
                       InterruptedException

Description copied from interface: RecordReader

Called once at initialization.

Specified by:

initialize in interface RecordReader

Parameters:

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

Throws:

IOException

InterruptedException

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

Parameters:

conf - a configuration for initialization

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

Throws:

IOException

InterruptedException

batchesSupported

public boolean batchesSupported()

Description copied from interface: RecordReader

This method returns true, if next(int) signature is supported by this RecordReader implementation.

Specified by:

batchesSupported in interface RecordReader

Returns:

next

public List<List<Writable>> next(int num)

Description copied from interface: RecordReader

This method will be used, if batchesSupported() returns true.

Specified by:

next in interface RecordReader

Returns:

next

public List<Writable> next()

Description copied from interface: RecordReader

Get the next record

Specified by:

next in interface RecordReader

Returns:

hasNext

public boolean hasNext()

Description copied from interface: RecordReader

Whether there are anymore records

Specified by:

hasNext in interface RecordReader

Returns:

getLabels

public List<String> getLabels()

Description copied from interface: RecordReader

List of label strings

Specified by:

getLabels in interface RecordReader

Returns:

reset

public void reset()

Description copied from interface: RecordReader

Reset record reader iterator

Specified by:

reset in interface RecordReader

resetSupported

public boolean resetSupported()

Specified by:

resetSupported in interface RecordReader

Returns:

True if the record reader can be reset, false otherwise. Note that some record readers cannot be reset - for example, if they are backed by a non-resettable input split (such as certain types of streams)

record

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

Description copied from interface: RecordReader

Load the 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:

record in interface RecordReader

Throws:

IOException - if error occurs during reading from the input stream

nextRecord

public Record nextRecord()

Description copied from interface: RecordReader

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

Specified by:

nextRecord in interface RecordReader

Returns:

next record

loadFromMetaData

public Record loadFromMetaData(RecordMetaData recordMetaData)
                        throws IOException

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

Parameters:

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

Returns:

Single record for the given RecordMetaData instance

Throws:

IOException - If I/O error occurs during loading

loadFromMetaData

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

Description copied from interface: RecordReader

Load multiple records from the given a list of RecordMetaData instances

Specified by:

loadFromMetaData in interface RecordReader

Parameters:

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

Returns:

Multiple records for the given RecordMetaData instances

Throws:

IOException - If I/O error occurs during loading

getListeners

public List<RecordListener> getListeners()

Description copied from interface: RecordReader

Get the record listeners for this record reader.

Specified by:

getListeners in interface RecordReader

setListeners

public void setListeners(RecordListener... listeners)

Description copied from interface: RecordReader

Set the record listeners for this record reader.

Specified by:

setListeners in interface RecordReader

setListeners

public void setListeners(Collection<RecordListener> listeners)

Description copied from interface: RecordReader

Set the record listeners for this record reader.

Specified by:

setListeners in interface RecordReader

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

setConf

public void setConf(Configuration conf)

Description copied from interface: Configurable

Set the configuration to be used by this object.

Specified by:

setConf in interface Configurable

getConf

public Configuration getConf()

Description copied from interface: Configurable

Return the configuration used by this object.

Specified by:

getConf in interface Configurable