# Skipgram

public final class **Skipgram** Parses a text file and creates a batch of examples.

### Nested Classes

|---|---|---|---|
| class | [Skipgram.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram.Options) || Optional attributes for `https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram` |

### Public Methods

|---|---|
| static [Skipgram](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram) | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram#create(org.tensorflow.op.Scope,%20java.lang.String,%20java.lang.Long,%20org.tensorflow.op.core.Skipgram.Options...))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, String filename, Long batchSize, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram.Options) options) Factory method to create a class wrapping a new Skipgram operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Integer\> | [currentEpoch](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram#currentEpoch())() The current epoch number. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Integer\> | [examples](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram#examples())() A vector of word ids. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Integer\> | [labels](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram#labels())() A vector of word ids. |
| static [Skipgram.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram.Options) | [minCount](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram#minCount(java.lang.Long))(Long minCount) |
| static [Skipgram.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram.Options) | [subsample](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram#subsample(java.lang.Float))(Float subsample) |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Long\> | [totalWordsProcessed](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram#totalWordsProcessed())() The total number of words processed so far. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Integer\> | [vocabFreq](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram#vocabFreq())() Frequencies of words. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<String\> | [vocabWord](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram#vocabWord())() A vector of words in the corpus. |
| static [Skipgram.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram.Options) | [windowSize](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram#windowSize(java.lang.Long))(Long windowSize) |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Long\> | [wordsPerEpoch](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram#wordsPerEpoch())() Number of words per epoch in the data file. |

### Inherited Methods

From class [org.tensorflow.op.PrimitiveOp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp)

|---|---|
| final boolean | [equals](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |
| final int | [hashCode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |
| [Operation](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation) | [op](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying `https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation` |
| final String | [toString](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |

From class java.lang.Object

|---|---|
| boolean | equals(Object arg0) |
| final Class\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| String | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Methods

#### public static [Skipgram](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram)
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, String filename, Long batchSize, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram.Options) options)

Factory method to create a class wrapping a new Skipgram operation.

##### Parameters

| scope | current scope |
| filename | The corpus's text file name. |
| batchSize | The size of produced batch. |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of Skipgram

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Integer\>
**currentEpoch**
()

The current epoch number.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Integer\>
**examples**
()

A vector of word ids.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Integer\>
**labels**
()

A vector of word ids.

#### public static [Skipgram.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram.Options)
**minCount**
(Long minCount)

<br />

##### Parameters

| minCount | The minimum number of word occurrences for it to be included in the vocabulary. |
|---|---|

#### public static [Skipgram.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram.Options)
**subsample**
(Float subsample)

<br />

##### Parameters

| subsample | Threshold for word occurrence. Words that appear with higher frequency will be randomly down-sampled. Set to 0 to disable. |
|---|---|

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Long\>
**totalWordsProcessed**
()

The total number of words processed so far.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Integer\>
**vocabFreq**
()

Frequencies of words. Sorted in the non-ascending order.

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<String\>
**vocabWord**
()

A vector of words in the corpus.

#### public static [Skipgram.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Skipgram.Options)
**windowSize**
(Long windowSize)

<br />

##### Parameters

| windowSize | The number of words to predict to the left and right of the target. |
|---|---|

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Long\>
**wordsPerEpoch**
()

Number of words per epoch in the data file.