org.deeplearning4j.text.documentiterator

Class LabelsSource

java.lang.Object

org.deeplearning4j.text.documentiterator.LabelsSource

All Implemented Interfaces:

java.io.Serializable

public class LabelsSource
extends java.lang.Object
implements java.io.Serializable

This class is used to manage labels/documents syncronization over iterators

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LabelsSource()
LabelsSource(java.util.List<java.lang.String> labels) Build LabelsSource using externally defined list of string labels.
LabelsSource(java.lang.String template) Build LabelsSource using string template.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getLabels() This method returns the list of labels used by this generator instance.
int	getNumberOfLabelsUsed() This method returns number of labels used up to the method's call
int	indexOf(java.lang.String label)
java.lang.String	nextLabel() Returns next label.
void	reset() This method should be called from Iterator's reset() method, to keep labels in sync with iterator
int	size()
void	storeLabel(java.lang.String label) This method is intended for storing labels retrieved from external sources.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelsSource

public LabelsSource()

LabelsSource

public LabelsSource(@NonNull
                    java.lang.String template)

Build LabelsSource using string template. Template can be raw string, in this case document counter will be appended to resulting label. I.e. "SENT_" template will produce labels SENT_0, SENT_1, SENT_2 etc. You can also use %d formatter tag, which will be replaced with counter. I.e. "SENT_%i_FLOW_1" will produce labels "SENT_0_FLOW_1", "SENT_1_FLOW_1", "SENT_2_FLOW_1" etc

Parameters:

template -

LabelsSource

public LabelsSource(@NonNull
                    java.util.List<java.lang.String> labels)

Build LabelsSource using externally defined list of string labels. Please note, in this case you have to make sure, the number of documents and number of labels match.

Parameters:

labels -

Method Detail

indexOf

public int indexOf(java.lang.String label)

size

public int size()

nextLabel

public java.lang.String nextLabel()

Returns next label.

Returns:

next label, generated or predefined one

getLabels

public java.util.List<java.lang.String> getLabels()

This method returns the list of labels used by this generator instance. If external list os labels was used as source, whole list will be returned.

Returns:

list of labels

storeLabel

public void storeLabel(java.lang.String label)

This method is intended for storing labels retrieved from external sources.

Parameters:

label -

reset

public void reset()

This method should be called from Iterator's reset() method, to keep labels in sync with iterator

getNumberOfLabelsUsed

public int getNumberOfLabelsUsed()

This method returns number of labels used up to the method's call

Returns: