This framework provides out-of-the-box implementations of Referential Games variants in order to study the emergence of artificial languages using deep learning, relying on PyTorch. This framework has been in constant development since July 2019. The following paper details its main features:

ReferentialGym: A Nomenclature and Framework for Language Emergence & Grounding in (Visual) Referential Games (or workshop link 2) Kevin Denamganaï and James Alfred Walker. 4th NeurIPS Workshop on Emergent Communication: "Talking with Strangers: Zero-Shot Emergent Communication", 2020.

• Provides an interface for dataset to be used in the context of referential games.

• Provides state-of-the-art language emergence algorithms based on referential game variants that can be configured at will by the users.
• Provides common implementations of various metrics, e.g. topographic similarity as a compositionality metric, causal influence of communication metric, FactorVAE's disentanglement metric ...

Tutorials:

• Getting Started: Learn how to use the framework's features out-of-the-box with different agent architectures and referential game variants.
• Creating New Modules: Learn how to create new modules either as part of the agents' architecture or as a new metric.

All relevant documentation can be found here and in the above-mentioned paper. Refer to source code for more specific documentation.

This project has not yet been uploaded to PyPi.

Clone this repository:

git clone https://github.com/Near32/ReferentialGym

And, install it locally:

cd ReferentialGym/
pip install -e .

This package enforces Python version 3.6 or higher. Python dependencies are listed in the file setup.py.

Read License.