<br />

- **Description**:

SCAN tasks with various splits.

SCAN is a set of simple language-driven navigation tasks for studying
compositional learning and zero-shot generalization.

Most splits are described at <https://github.com/brendenlake/SCAN> For the MCD
splits please see <https://arxiv.org/abs/1912.09713.pdf>

Basic usage:

    data = tfds.load('scan/length')

More advanced example:

    import tensorflow_datasets as tfds
    from tensorflow_datasets.datasets.scan import scan_dataset_builder

    data = tfds.load(
        'scan',
        builder_kwargs=dict(
            config=scan_dataset_builder.ScanConfig(
                name='simple_p8', directory='simple_split/size_variations')))

- **Additional Documentation** :
  [Explore on Papers With Code](https://paperswithcode.com/dataset/scan)

- **Homepage** :
  <https://github.com/brendenlake/SCAN>

- **Source code** :
  [`tfds.datasets.scan.Builder`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/datasets/scan/scan_dataset_builder.py)

- **Versions**:

  - **`1.1.1`** (default): No release notes.
- **Auto-cached**
  ([documentation](https://www.tensorflow.org/datasets/performances#auto-caching)):
  Yes

- **Feature structure**:

    FeaturesDict({
        'actions': Text(shape=(), dtype=string),
        'commands': Text(shape=(), dtype=string),
    })

- **Feature documentation**:

| Feature | Class | Shape | Dtype | Description |
|---|---|---|---|---|
|   | FeaturesDict |   |   |   |
| actions | Text |   | string |   |
| commands | Text |   | string |   |

- **Supervised keys** (See
  [`as_supervised` doc](https://www.tensorflow.org/datasets/api_docs/python/tfds/load#args)):
  `('commands', 'actions')`

- **Figure**
  ([tfds.show_examples](https://www.tensorflow.org/datasets/api_docs/python/tfds/visualization/show_examples)):
  Not supported.

- **Citation**:

    @inproceedings{Lake2018GeneralizationWS,
      title={Generalization without Systematicity: On the Compositional Skills of
             Sequence-to-Sequence Recurrent Networks},
      author={Brenden M. Lake and Marco Baroni},
      booktitle={ICML},
      year={2018},
      url={https://arxiv.org/pdf/1711.00350.pdf},
    }
    @inproceedings{Keysers2020,
      title={Measuring Compositional Generalization: A Comprehensive Method on
             Realistic Data},
      author={Daniel Keysers and Nathanael Sch\"{a}rli and Nathan Scales and
              Hylke Buisman and Daniel Furrer and Sergii Kashubin and
              Nikola Momchev and Danila Sinopalnikov and Lukasz Stafiniak and
              Tibor Tihon and Dmitry Tsarkov and Xiao Wang and Marc van Zee and
              Olivier Bousquet},
      note={Additional citation for MCD splits},
      booktitle={ICLR},
      year={2020},
      url={https://arxiv.org/abs/1912.09713.pdf},
    }

## scan/simple (default config)

- **Download size** : `17.82 MiB`

- **Dataset size** : `4.47 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 4,182 |
| `'train'` | 16,728 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_cdf1a6f0d594bb7e7120476f6d36a2d82a299b310982e2cb8d56994d7bac6558.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/addprim_jump

- **Download size** : `17.82 MiB`

- **Dataset size** : `4.53 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 7,706 |
| `'train'` | 14,670 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_422e836bce1800c691376a4b548cf42cbea185cdb5d75f3eb55868c45d37d6d2.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/addprim_turn_left

- **Download size** : `17.82 MiB`

- **Dataset size** : `4.58 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 1,208 |
| `'train'` | 21,890 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_3b570d7c0f6a541f165eec86ac3dfb9cffe80f9d04e45bd2bb801e7b20ec400c.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/filler_num0

- **Download size** : `17.82 MiB`

- **Dataset size** : `3.20 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 1,173 |
| `'train'` | 15,225 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_885c03a3ab81be330f12e17b458d4225df6136bfbcd20f30275737f3e63288d2.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/filler_num1

- **Download size** : `17.82 MiB`

- **Dataset size** : `3.51 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 1,173 |
| `'train'` | 16,290 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_ed244f6ffe1fa0ba190d23df8feb7779b3a1259283ba4c130c821de265222dbb.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/filler_num2

- **Download size** : `17.82 MiB`

- **Dataset size** : `3.84 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 1,173 |
| `'train'` | 17,391 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_aaf17be82f4e2d3d0120e7ee54f68a72e0d2652f4d7cf114dba0d12216ba6314.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/filler_num3

- **Download size** : `17.82 MiB`

- **Dataset size** : `4.17 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 1,173 |
| `'train'` | 18,528 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_c824b8c297a98cdc057be58607b292d9c87f0664f37ccb50196cbe8f21839fa5.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/length

- **Download size** : `17.82 MiB`

- **Dataset size** : `4.47 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 3,920 |
| `'train'` | 16,990 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_f786d161f63b83de931cb0eec32f76e42b89d4a1975e2377930e60fc8882ecc3.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/template_around_right

- **Download size** : `17.82 MiB`

- **Dataset size** : `4.17 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 4,476 |
| `'train'` | 15,225 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_cc0683454f7e232eaf3a9271c806dda65deb43946c43cc7759658197c5f944b7.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/template_jump_around_right

- **Download size** : `17.82 MiB`

- **Dataset size** : `4.17 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 1,173 |
| `'train'` | 18,528 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_24134e849ccb8b60d578cf74dbb73d3bc95dbade27ed809027b9790cf3b2b773.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/template_opposite_right

- **Download size** : `17.82 MiB`

- **Dataset size** : `4.22 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 4,476 |
| `'train'` | 15,225 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_7ab6d39a75595ce7da9e29a0929757528c4d4d4e1385cbae4433a2edf0b06205.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/template_right

- **Download size** : `17.82 MiB`

- **Dataset size** : `4.26 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 4,476 |
| `'train'` | 15,225 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_4db855a0ef2fdd2d114d97bb8eacfb5f33e6ce6ced1f2bead5eec1762a5b28ba.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/mcd1

- **Download size** : `17.89 MiB`

- **Dataset size** : `1.89 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 1,045 |
| `'train'` | 8,365 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_2382ddde9b508ca2bcdbaccfbf136c314ae70071729886bf166aafd6b39b10db.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/mcd2

- **Download size** : `17.89 MiB`

- **Dataset size** : `1.84 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 1,045 |
| `'train'` | 8,365 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_d00f48e7036ce394137224c5e4e1581d3ebdb652da0aa2b54a6d90f597befb70.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>

## scan/mcd3

- **Download size** : `17.89 MiB`

- **Dataset size** : `1.87 MiB`

- **Splits**:

| Split | Examples |
|---|---|
| `'test'` | 1,045 |
| `'train'` | 8,365 |

- **Examples** ([tfds.as_dataframe](https://www.tensorflow.org/datasets/api_docs/python/tfds/as_dataframe)):

<iframe src="https:///frame/datasets/catalog/scan_1e48810211e0397af2ba6d495f8aff6419f2cb763b2b34239dee5680e26042cb.frame" class="framebox inherit-locale " allow="clipboard-write https://" allowfullscreen is-upgraded></iframe>