parlai.core.mutators¶
-
parlai.core.mutators.
setup_mutator_registry
()[source]¶ Loads the mutators so that @register_mutator is hit for all.
-
parlai.core.mutators.
register_mutator
(name: str) → Callable[[Type], Type][source]¶ Register a mutator.
-
class
parlai.core.mutators.
Mutator
(opt)[source]¶ Bases:
abc.ABC
Base class for mutators.
Users are not advised to use this class.
-
class
parlai.core.mutators.
MessageMutator
(opt)[source]¶ Bases:
parlai.core.mutators.Mutator
Message-level mutators.
Message-level mutators have a function applied per-utterance. They are ideal for transformations of data which don’t create any new conversations or turns, but only apply simple text-transformations.
Examples include:
Shuffling words in context
Adding a special token based on a non-text field
Replacing words with synonyms or other simple augmentations
-
class
parlai.core.mutators.
EpisodeMutator
(opt)[source]¶ Bases:
parlai.core.mutators.Mutator
Episode-level mutators.
-
abstract
episode_mutation
(episode: List[parlai.core.message.Message]) → List[parlai.core.message.Message][source]¶ Abstract episode mutation.
The main method to implement when implementing an EpisodeMutator.
The “episode_done” field will be automatically stripped before providing as input, and automatically added back to the finalized episode.
- Parameters
messages – All the messages in one episode. You may manipulate any or all of them, or change the ordering entirely.
- Returns
The new, mutated episode.
-
abstract
-
class
parlai.core.mutators.
ManyEpisodeMutator
(opt)[source]¶ Bases:
parlai.core.mutators.Mutator
Episode mutator than can map one episode to zero or more.
-
abstract
many_episode_mutation
(episode: List[parlai.core.message.Message]) → List[List[parlai.core.message.Message]][source]¶ Abstract many-episode mutation.
The main method to implement when creation a ManyEpisodeMutator. You should map this episode to zero-or-more episodes.
If you wish to create multiple episodes, you need to output one-sublist-per-new-episode. As with EpisodeMutator, “episode_done” will be automatically stripped and re-inserted for you.
- Parameters
episode – A single episode (provided list of Messages).
- Returns
A list of list of messages. Each sub-list will be turned into a new episode.
-
abstract