SentenceTransformer (deeplearning4j-nlp 1.0.0-M2.1 API)

java.lang.Object
- org.deeplearning4j.models.sequencevectors.transformers.impl.SentenceTransformer

All Implemented Interfaces:: Iterable<Sequence<VocabWord>>, SequenceTransformer<VocabWord,String>

public class SentenceTransformer
extends Object
implements SequenceTransformer<VocabWord,String>, Iterable<Sequence<VocabWord>>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SentenceTransformer.Builder

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`allowMultithreading`
`protected BasicTransformerIterator`	`currentIterator`
`protected LabelAwareIterator`	`iterator`
`protected static org.slf4j.Logger`	`log`
`protected boolean`	`readOnly`
`protected AtomicInteger`	`sentenceCounter`
`protected TokenizerFactory`	`tokenizerFactory`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Iterator<Sequence<VocabWord>>`	`iterator()`
`void`	`reset()`
`Sequence<VocabWord>`	`transformToSequence(String object)`	This is generic method for transformation data from any format to Sequence of SequenceElement.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - tokenizerFactory
```
protected TokenizerFactory tokenizerFactory
```
  - iterator
```
protected LabelAwareIterator iterator
```
  - readOnly
```
protected boolean readOnly
```
  - sentenceCounter
```
protected AtomicInteger sentenceCounter
```
  - allowMultithreading
```
protected boolean allowMultithreading
```
  - currentIterator
```
protected BasicTransformerIterator currentIterator
```
  - log
```
protected static final org.slf4j.Logger log
```
- Method Detail
  - transformToSequence
```
public Sequence<VocabWord> transformToSequence(String object)
```
    Description copied from interface: SequenceTransformer
    
    This is generic method for transformation data from any format to Sequence of SequenceElement. It will be used both in Vocab building, and in training process
    
    Specified by:
    
    transformToSequence in interface SequenceTransformer<VocabWord,String>
    
    Parameters:
    
    object - - Object to be transformed into Sequence
    
    Returns:
  - iterator
```
public Iterator<Sequence<VocabWord>> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Sequence<VocabWord>>
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface SequenceTransformer<VocabWord,String>