Package: emlangkit
Emergent Language Analysis ToolkitThis toolkit aims to collect all metrics currently used in emergent
communication research into one place. The usage should be convenient and the
inputs should be standardised, to ease adoption and spread of these metrics.InstallationTo install emlangkit, runpip install emlangkit.Automatic tests are run for Python 3.9, 3.10, 3.11.UsageAll metrics are available through theLanguageclass inemlangkit.Language.
This class accepts two numpy arrays as inputs - messages and observations. These
are then used, with some possible speedups, to calculate any requested metric,
as per example belowimportnumpyasnpfromemlangkitimportLanguagemessages=np.array([[1,2,0,3,4],[1,2,2,3,4],[1,2,2,3,0],[1,0,0,1,2]])observations=np.array([[4,4],[4,3],[3,2],[1,4]])lang=Language(messages=messages,observations=observations)score,p_value=lang.topsim()# Mutual information already requires both language and observation entropymi=lang.mutual_information()# So this call uses less computationlang_entropy=lang.language_entropy()MetricsCurrently available metrics, with their implementations as per below.Entropy [1,2] (emlangkit.metrics.entropy)Mutual Information [1,2] (emlangkit.metrics.mutual_information)Topographic Similarity [1,2,3] (emlangkit.metrics.topsim)Positional Disentanglement [2,4] (emlangkit.metrics.posdis)Bag-of-Words Disentanglement [2,4] (emlangkit.metrics.bosdis)M_previous^n [5] (emlangkit.metrics.mpn)ContributingAll pull requests are welcome! Just please make sure to install pre-commit and
run the pytests before submitting a PR. Additionally, if a lot of new code is
added, please also add the relevant tests.Related LibrariesThis is a non-exhaustive list of libraries related to EC research. Please feel
free to open a PR to add to it!EGG -https://github.com/facebookresearch/EGGHarris' Articulation Scheme -https://github.com/wedddy0707/HarrisSegmentationCGI -https://github.com/wedddy0707/categorial_grammar_induction_of_emergent_languageCitationIf you find emlangkit useful in your work, please cite it as below:@software{lipinski_emlangkit_2023,
        title = {emlangkit: Emergent Language Analysis Toolkit},
        url = {https://github.com/olipinski/emlangkit},
        author = {Lipinski, Olaf},
        year = {2023}
}SourcesMost of the base metrics are inspired or taken from eitherEGG, or code from the paper
"Catalytic Role Of Noise And Necessity Of Inductive Biases In The Emergence Of
Compositional Communication"here.Citations for the metrics and parts of this software:[1] L. Kucinski, T. Korbak, P. Kolodziej, and P. Milos, ‘Catalytic Role Of
Noise And Necessity Of Inductive Biases In The Emergence Of Compositional
Communication’, NeurIPS 2021[2] E. Kharitonov, R. Chaabouni, D. Bouchacourt, and M. Baroni, ‘EGG: a
toolkit for research on Emergence of lanGuage in Games’, EMNLP-IJCNLP 2019[3] H. Brighton and S. Kirby, ‘Understanding Linguistic Evolution by
Visualizing the Emergence of Topographic Mappings’, Artificial Life, vol. 12,
no. 2, pp. 229–242, Apr. 2006[4] R. Chaabouni, E. Kharitonov, D. Bouchacourt, E. Dupoux, and M. Baroni,
‘Compositionality and Generalization In Emergent Languages’, ACL 2020[5] O. Lipinski, A. J. Sobey, F. Cerutti, and T. J. Norman, ‘On Temporal
References in Emergent Communication’. arXiv.2310.06555[6] R. Ueda, T. Ishii, and Y. Miyao, ‘On the Word Boundaries of Emergent
Languages Based on Harris’s Articulation Scheme’, ICLR 2023