<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/datasets/blob/v4.9.10/tensorflow_datasets/core/deprecated/text/text_encoder.py#L61-L113) |

Abstract base class for converting between text and integers.

**A note on padding**:

Because text data is typically variable length and nearly always requires
padding during training, ID 0 is always reserved for padding. To accommodate
this, all `TextEncoder`s behave in certain ways:

- `encode`: never returns id 0 (all ids are 1+)
- `decode`: drops 0 in the input ids
- `vocab_size`: includes ID 0

  New subclasses should be careful to match this behavior.

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `vocab_size` | Size of the vocabulary. Decode produces ints \[1, vocab_size). |

<br />

## Methods

### `decode`

[View source](https://github.com/tensorflow/datasets/blob/v4.9.10/tensorflow_datasets/core/deprecated/text/text_encoder.py#L82-L85)

    @abc.abstractmethod
    decode(
        ids
    )

Decodes a list of integers into text.

### `encode`

[View source](https://github.com/tensorflow/datasets/blob/v4.9.10/tensorflow_datasets/core/deprecated/text/text_encoder.py#L77-L80)

    @abc.abstractmethod
    encode(
        s
    )

Encodes text into a list of integers.

### `load_from_file`

[View source](https://github.com/tensorflow/datasets/blob/v4.9.10/tensorflow_datasets/core/deprecated/text/text_encoder.py#L97-L101)

    @classmethod
    @abc.abstractmethod
    load_from_file(
        filename_prefix
    )

Load from file. Inverse of save_to_file.

### `save_to_file`

[View source](https://github.com/tensorflow/datasets/blob/v4.9.10/tensorflow_datasets/core/deprecated/text/text_encoder.py#L92-L95)

    @abc.abstractmethod
    save_to_file(
        filename_prefix
    )

Store to file. Inverse of load_from_file.