InvertedIndex (deeplearning4j-nlp 0.0.3.3 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

LuceneInvertedIndex
```
public interface InvertedIndex
extends Serializable
```
An inverted index for mapping words to documents and documents to words

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addLabelForDoc(int doc, String label)` Adds words to the given document
`void`	`addLabelForDoc(int doc, VocabWord word)` Add word to a document
`void`	`addLabelsForDoc(int doc, Collection<String> label)` Adds words to the given document
`void`	`addLabelsForDoc(int doc, List<VocabWord> word)` Add word to a document
`void`	`addWordsToDoc(int doc, List<VocabWord> words)` Adds words to the given document
`void`	`addWordsToDoc(int doc, List<VocabWord> words, Collection<String> label)` Adds words to the given document
`void`	`addWordsToDoc(int doc, List<VocabWord> words, String label)` Adds words to the given document
`void`	`addWordsToDoc(int doc, List<VocabWord> words, VocabWord label)` Adds words to the given document
`void`	`addWordsToDocVocabWord(int doc, List<VocabWord> words, Collection<VocabWord> label)` Adds words to the given document
`void`	`addWordToDoc(int doc, VocabWord word)` Add word to a document
`int[]`	`allDocs()` Returns a list of all documents
`Iterator<List<List<VocabWord>>>`	`batchIter(int batchSize)` Iterate over batches
`int`	`batchSize()` For word vectors, this is the batch size for which to train on
`void`	`cleanup()` Cleanup any resources used
`Iterator<List<VocabWord>>`	`docs()` Iterate over documents
`List<VocabWord>`	`document(int index)` Returns a list of words for a document
`int[]`	`documents(VocabWord vocabWord)` Returns the list of documents a vocab word is in
`Pair<List<VocabWord>,String>`	`documentWithLabel(int index)` Returns a list of words for a document and the associated label
`Pair<List<VocabWord>,Collection<String>>`	`documentWithLabels(int index)` Returns a list of words associated with the document and the associated labels
`void`	`eachDoc(com.google.common.base.Function<List<VocabWord>,Void> func, ExecutorService exec)` Iterate over each document
`void`	`eachDocWithLabel(com.google.common.base.Function<Pair<List<VocabWord>,String>,Void> func, ExecutorService exec)` Iterate over each document with a label
`void`	`eachDocWithLabels(com.google.common.base.Function<Pair<List<VocabWord>,Collection<String>>,Void> func, ExecutorService exec)` Iterate over each document with a label
`void`	`finish()` Finishes saving data
`Iterator<List<VocabWord>>`	`miniBatches()` Iterates over mini batches
`int`	`numDocuments()` Returns the number of documents
`double`	`sample()` Sampling for creating mini batches
`int`	`totalWords()` Total number of words in the index
`void`	`unlock()` Unlock the index

- Method Detail
  - batchIter
```
Iterator<List<List<VocabWord>>> batchIter(int batchSize)
```
    Iterate over batches
    
    Returns:
    
    the batch size
  - docs
```
Iterator<List<VocabWord>> docs()
```
    Iterate over documents
    
    Returns:
  - unlock
```
void unlock()
```
    Unlock the index
  - cleanup
```
void cleanup()
```
    Cleanup any resources used
  - sample
```
double sample()
```
    Sampling for creating mini batches
    
    Returns:
    
    the sampling for mini batches
  - miniBatches
```
Iterator<List<VocabWord>> miniBatches()
```
    Iterates over mini batches
    
    Returns:
    
    the mini batches created by this vectorizer
  - document
```
List<VocabWord> document(int index)
```
    Returns a list of words for a document
    
    Parameters:
    
    index -
    
    Returns:
  - documentWithLabel
```
Pair<List<VocabWord>,String> documentWithLabel(int index)
```
    Returns a list of words for a document and the associated label
    
    Parameters:
    
    index -
    
    Returns:
  - documentWithLabels
```
Pair<List<VocabWord>,Collection<String>> documentWithLabels(int index)
```
    Returns a list of words associated with the document and the associated labels
    
    Parameters:
    
    index -
    
    Returns:
  - documents
```
int[] documents(VocabWord vocabWord)
```
    Returns the list of documents a vocab word is in
    
    Parameters:
    
    vocabWord - the vocab word to get documents for
    
    Returns:
    
    the documents for a vocab word
  - numDocuments
```
int numDocuments()
```
    Returns the number of documents
    
    Returns:
  - allDocs
```
int[] allDocs()
```
    Returns a list of all documents
    
    Returns:
    
    the list of all documents
  - addWordToDoc
```
void addWordToDoc(int doc,
                  VocabWord word)
```
    Add word to a document
    
    Parameters:
    
    doc - the document to add to
    
    word - the word to add
  - addWordsToDoc
```
void addWordsToDoc(int doc,
                   List<VocabWord> words)
```
    Adds words to the given document
    
    Parameters:
    
    doc - the document to add to
    
    words - the words to add
  - addLabelForDoc
```
void addLabelForDoc(int doc,
                    VocabWord word)
```
    Add word to a document
    
    Parameters:
    
    doc - the document to add to
    
    word - the word to add
  - addLabelForDoc
```
void addLabelForDoc(int doc,
                    String label)
```
    Adds words to the given document
    
    Parameters:
    
    doc - the document to add to
  - addWordsToDoc
```
void addWordsToDoc(int doc,
                   List<VocabWord> words,
                   String label)
```
    Adds words to the given document
    
    Parameters:
    
    doc - the document to add to
    
    words - the words to add
    
    label - the label for the document
  - addWordsToDoc
```
void addWordsToDoc(int doc,
                   List<VocabWord> words,
                   VocabWord label)
```
    Adds words to the given document
    
    Parameters:
    
    doc - the document to add to
    
    words - the words to add
    
    label - the label for the document
  - addLabelsForDoc
```
void addLabelsForDoc(int doc,
                     List<VocabWord> word)
```
    Add word to a document
    
    Parameters:
    
    doc - the document to add to
    
    word - the word to add
  - addLabelsForDoc
```
void addLabelsForDoc(int doc,
                     Collection<String> label)
```
    Adds words to the given document
    
    Parameters:
    
    doc - the document to add to
    
    label - the labels to add
  - addWordsToDoc
```
void addWordsToDoc(int doc,
                   List<VocabWord> words,
                   Collection<String> label)
```
    Adds words to the given document
    
    Parameters:
    
    doc - the document to add to
    
    words - the words to add
    
    label - the label for the document
  - addWordsToDocVocabWord
```
void addWordsToDocVocabWord(int doc,
                            List<VocabWord> words,
                            Collection<VocabWord> label)
```
    Adds words to the given document
    
    Parameters:
    
    doc - the document to add to
    
    words - the words to add
    
    label - the label for the document
  - finish
```
void finish()
```
    Finishes saving data
  - totalWords
```
int totalWords()
```
    Total number of words in the index
    
    Returns:
    
    the total number of words in the index
  - batchSize
```
int batchSize()
```
    For word vectors, this is the batch size for which to train on
    
    Returns:
    
    the batch size for which to train on
  - eachDocWithLabels
```
void eachDocWithLabels(com.google.common.base.Function<Pair<List<VocabWord>,Collection<String>>,Void> func,
                       ExecutorService exec)
```
    Iterate over each document with a label
    
    Parameters:
    
    func - the function to apply
    
    exec - executor service for execution
  - eachDocWithLabel
```
void eachDocWithLabel(com.google.common.base.Function<Pair<List<VocabWord>,String>,Void> func,
                      ExecutorService exec)
```
    Iterate over each document with a label
    
    Parameters:
    
    func - the function to apply
    
    exec - executor service for execution
  - eachDoc
```
void eachDoc(com.google.common.base.Function<List<VocabWord>,Void> func,
             ExecutorService exec)
```
    Iterate over each document
    
    Parameters:
    
    func - the function to apply
    
    exec - executor service for execution

Interface InvertedIndex

Method Summary

Method Detail

batchIter

docs

unlock

cleanup

sample

miniBatches

document

documentWithLabel

documentWithLabels

documents

numDocuments

allDocs

addWordToDoc

addWordsToDoc

addLabelForDoc

addLabelForDoc

addWordsToDoc

addWordsToDoc

addLabelsForDoc

addLabelsForDoc

addWordsToDoc

addWordsToDocVocabWord

finish

totalWords

batchSize

eachDocWithLabels

eachDocWithLabel

eachDoc