Corruption results
~~~~~~~~~~~~~~~~~~

.. py:module:: langsim.modules.local_lm.corruption_results

+------------+---------------------------------------------+
| Path       | langsim.modules.local_lm.corruption_results |
+------------+---------------------------------------------+
| Executable | yes                                         |
+------------+---------------------------------------------+

Collect results from the corruption experiments, including models trained on corrupted
corpora, and analyse them.


Inputs
======

+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name              | Type(s)                                                                                                                                                                                                                                                                    |
+===================+============================================================================================================================================================================================================================================================================+
| corruption_params | :class:`list <pimlico.datatypes.base.MultipleInputs>` of A file collection containing at least one file (or a given specific number). No constraint is put on the name of the file(s). Typically, the module will just use whatever the first file(s) in the collection is |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| models            | :class:`list <pimlico.datatypes.base.MultipleInputs>` of :class:`KerasModelBuilderClass <pimlico.datatypes.keras.KerasModelBuilderClass>`                                                                                                                                  |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vocab1s           | :class:`list <pimlico.datatypes.base.MultipleInputs>` of :class:`Dictionary <pimlico.datatypes.dictionary.Dictionary>`                                                                                                                                                     |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vocab2s           | :class:`list <pimlico.datatypes.base.MultipleInputs>` of :class:`Dictionary <pimlico.datatypes.dictionary.Dictionary>`                                                                                                                                                     |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mapped_pairs      | :class:`list <pimlico.datatypes.base.MultipleInputs>` of A file collection containing at least one file (or a given specific number). No constraint is put on the name of the file(s). Typically, the module will just use whatever the first file(s) in the collection is |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Outputs
=======

+----------+---------------------------------------------------------+
| Name     | Type(s)                                                 |
+==========+=========================================================+
| analysis | :func:`~pimlico.datatypes.files.NamedFile`              |
+----------+---------------------------------------------------------+
| files    | :class:`~pimlico.datatypes.files.UnnamedFileCollection` |
+----------+---------------------------------------------------------+