Skip to content

Commit

Permalink
Update README and release
Browse files Browse the repository at this point in the history
Signed-off-by: Olaf Lipinski <o.lipinski@soton.ac.uk>
  • Loading branch information
olipinski committed Nov 6, 2023
1 parent cd8575b commit 849b59d
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 14 deletions.
44 changes: 31 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,12 @@ lang_entropy = lang.language_entropy()

Currently available metrics, with their implementations as per below.

- Entropy (`emlangkit.metrics.entropy`)
- Mutual Information (`emlangkit.metrics.mutual_information`)
- Topographic Similarity (`emlangkit.metrics.topsim`)
- Positional Disentanglement (`emlangkit.metrics.posdis`)
- Bag-of-Words Disentanglement (`emlangkit.metrics.bosdis`)
- 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`)

## Contributing

Expand All @@ -66,14 +67,6 @@ free to open a PR to add to it!
- CGI -
https://github.com/wedddy0707/categorial_grammar_induction_of_emergent_language

## Sources

Most of the base metrics are inspired or taken from either
[EGG](https://github.com/facebookresearch/EGG), or code from the paper
"Catalytic Role Of Noise And Necessity Of Inductive Biases In The Emergence Of
Compositional Communication"
[here](https://proceedings.neurips.cc/paper/2021/hash/c2839bed26321da8b466c80a032e4714-Abstract.html).

## Citation

If you find emlangkit useful in your work, please cite it as below:
Expand All @@ -86,3 +79,28 @@ If you find emlangkit useful in your work, please cite it as below:
year = {2023}
}
```

## Sources

Most of the base metrics are inspired or taken from either
[EGG](https://github.com/facebookresearch/EGG), or code from the paper
"Catalytic Role Of Noise And Necessity Of Inductive Biases In The Emergence Of
Compositional Communication"
[here](https://proceedings.neurips.cc/paper/2021/hash/c2839bed26321da8b466c80a032e4714-Abstract.html).

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
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "emlangkit"
version = "0.0.1"
version = "0.1.0"
description = " Emergent Language Analysis Toolkit"
authors = [
{ name = "Olaf Lipinski", email = "o.lipinski@soton.ac.uk" },
Expand Down

0 comments on commit 849b59d

Please sign in to comment.