Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

update doc for passing mutator args to task-specific mutators #4349

Merged
merged 1 commit into from Feb 10, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/source/tutorial_mutators.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,22 @@ parlai display_data -t dailydialog:mutators=word_shuffle,convai2:mutators=flatte
```


### Mutator arguments

Some mutators have additional arguments. For example, `episode_shuffle` has an
argument `preserve_context`.

```bash
parlai display_data -t dailydialog --mutators episode_shuffle --preserve_context True
```

Unfortunately, mutator arguments cannot be directly specified when using the `--task X:mutators=` format. Instead, we can pass mutator arguments through the task argument.

```bash
parlai display_data -t dailydialog:mutators=episode_shuffle:preserve_context=True
```


## Writing your own Mutators

Mutators are meant to be added too. Following other patterns in ParlAI, you can
Expand Down