# ReferentialGym package

## Subpackages

- ReferentialGym.agents package
  - Submodules
  - ReferentialGym.agents.agent module
  - ReferentialGym.agents.attention_lstm_cnn_listener module
  - ReferentialGym.agents.caption_speaker module
  - ReferentialGym.agents.categorical_obverter_agent module
  - ReferentialGym.agents.differentiable_obverter_agent module
  - ReferentialGym.agents.differentiable_relational_obverter module
  - ReferentialGym.agents.discriminative_listener module
  - ReferentialGym.agents.eos_priored_lstm_cnn_speaker module
  - ReferentialGym.agents.generative_listener module
  - ReferentialGym.agents.listener module
  - ReferentialGym.agents.lstm_cnn_listener module
  - ReferentialGym.agents.lstm_cnn_speaker module
  - ReferentialGym.agents.multi_head_lstm_cnn_speaker module
  - ReferentialGym.agents.obverter_agent module
  - ReferentialGym.agents.speaker module
  - ReferentialGym.agents.transcoding_lstm_cnn_listener module
  - ReferentialGym.agents.transcoding_lstm_cnn_speaker module
  - Module contents
- ReferentialGym.datasets package
  - Submodules
  - ReferentialGym.datasets.CLEVR_dataset module
  - ReferentialGym.datasets.MSCOCO_dataset module
  - ReferentialGym.datasets.MineRL_dataset module
  - ReferentialGym.datasets.dSprites_dataset module
  - ReferentialGym.datasets.dataset module
  - ReferentialGym.datasets.dict_dataset_wrapper module
  - ReferentialGym.datasets.dual_labeled_dataset module
  - ReferentialGym.datasets.extended_sort_of_CLEVR_dataset module
  - ReferentialGym.datasets.labeled_dataset module
  - ReferentialGym.datasets.sort_of_CLEVR_dataset module
  - ReferentialGym.datasets.utils module
  - Module contents
- ReferentialGym.modules package
  - Submodules
  - ReferentialGym.modules.batch_reshape_module module
  - ReferentialGym.modules.batch_reshape_repeat_module module
  - ReferentialGym.modules.concat_module module
  - ReferentialGym.modules.current_agent_module module
  - ReferentialGym.modules.dsprites_per_latent_accuracy_metric_module module
  - ReferentialGym.modules.factor_vae_disentanglement_metric_module module
  - ReferentialGym.modules.flatten_module module
  - ReferentialGym.modules.grad_recorder_module module
  - ReferentialGym.modules.homoscedastic_multi_task_loss_module module
  - ReferentialGym.modules.instantaneous_coordination_metric_module module
  - ReferentialGym.modules.module module
  - ReferentialGym.modules.multi_head_classification_from_feature_map_module module
  - ReferentialGym.modules.multi_head_classification_module module
  - ReferentialGym.modules.multi_head_regression_module module
  - ReferentialGym.modules.optimization_module module
  - ReferentialGym.modules.per_epoch_logger_module module
  - ReferentialGym.modules.population_handler_module module
  - ReferentialGym.modules.squeeze_module module
  - ReferentialGym.modules.topographic_similarity_metric_module module
  - ReferentialGym.modules.visual_module module
  - Module contents
- ReferentialGym.networks package
  - Submodules
  - ReferentialGym.networks.autoregressive_networks module
  - ReferentialGym.networks.homoscedastic_multitask_loss module
  - ReferentialGym.networks.networks module
  - ReferentialGym.networks.residual_networks module
  - Module contents
- ReferentialGym.utils package
  - Subpackages
    - ReferentialGym.utils.statsLogger package
      - Submodules
      - ReferentialGym.utils.statsLogger.statsLogger module
      - Module contents
    - ReferentialGym.utils.streamHandler package
      - Submodules
      - ReferentialGym.utils.streamHandler.StreamHandler module
      - Module contents
  - Submodules
  - ReferentialGym.utils.utils module
  - Module contents

## Submodules

## ReferentialGym.referential_game module

class `ReferentialGym.referential_game.``ReferentialGame`(datasets, config, modules, pipelines)

  Bases: `object`

  `train`(nbr_epoch: int = 10, logger: tensorboardX.writer.SummaryWriter = None, verbose_period=None)

## Module contents

`ReferentialGym.``make`(config, dataset_args)

  Create a ReferentialGame with all the different evalutation modes, that are specified by the dataset_args’s mode entry. :param config: Dict that specifies all the important hyperparameters of the game. :param dataset_args: Dict with the following expected entries:

  > - dataset_class: None, ‘LabeledDataset’, or `’DualLabeledDataset’ is expected.

  >     It specifies the class of dataset decorator to use.

  > - modes: Dict of training/evaluation mode as keys and corresponding datasets as values.

  >     ‘test’ and ‘train’ are mandatory.