All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.deeplearning4j.text.documentiterator.LabelledDocument Maven / Gradle / Ivy

There is a newer version: 1.0.0-M2.1
Show newest version
package org.deeplearning4j.text.documentiterator;

import lombok.Data;
import lombok.ToString;
import org.deeplearning4j.models.word2vec.VocabWord;

import java.util.ArrayList;
import java.util.List;

/**
 * This is primitive holder of document, and it's label.
 *
 * @author [email protected]
 */
@Data
@ToString(exclude = "referencedContent")
public class LabelledDocument {

    // optional field
    private String id;

    // initial text representation of current document
    private String content;


    private List labels = new ArrayList<>();


    /*
        as soon as sentence was parsed for vocabulary words, there's no need to hold string representation, and we can just stick to references to those VocabularyWords
      */
    private List referencedContent;

    /**
     * This method returns first label for the document.
     *
     * PLEASE NOTE: This method is here only for backward compatibility purposes, getLabels() should be used instead.
     *
     * @return
     */
    @Deprecated
    public String getLabel() {
        return labels.get(0);
    }

    @Deprecated
    public void setLabel(String label) {
        if (!labels.isEmpty())
            labels.set(0, label);
        else
            labels.add(label);
    }

    public void addLabel(String label) {
        labels.add(label);
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy