Update README.md

README.md

@@ -1,13 +1,49 @@
-# Emergent Language Library
+# ELCC
 
+The Emergent Language Corpus Collection is collection of corpora and metadata
+from a variety of emergent communication simulations.
 
-## Running code
 
-For each emergent language entry, we provide wrapper code to create
-a reproducible environment and run the emergent language-generating code.
-Environments are specified precisely in the `environment.yml` file; if you wish
-to edit the dependencies manually, it may be easier to start with
-`environment.editable.yml` instead, if it exists. 
+## Using ELCC
+
+You can clone this repository with git LFS and use the data directly or load
+the data via the mlcroissant library.  To install the mlcroissant library and
+necessary dependencies, see the conda environment at `util/environment.yml`.
+Below we show an example of loading ELCC's data via mlcroissant.
+```python
+import mlcroissant as mlc
+
+cr_url = "https://huggingface.co/datasets/bboldt/elcc/raw/main/croissant.json"
+dataset = mlc.Dataset(jsonld=cr_url)
+
+# A raw corpus of integer arrays; the corpora are named based on their paths;
+# e..g., "systems/babyai-sr/data/GoToObj/corpus.json" becomes
+# "babyai-sr/GoToObj".
+records = dataset.records(record_set="babyai-sr/GoToObj")
+# System-level metadata
+records = dataset.records(record_set="system-metadata")
+# Raw JSON string for system metadata; some fields aren't handled well by
+# Croissant, so you can access them here if need be.
+records = dataset.records(record_set="system-metadata-raw")
+# Corpus metadata, specifically metrics generated by ELCC's analyses
+records = dataset.records(record_set="corpus-metadata")
+# Raw corpus metadata
+records = dataset.records(record_set="corpus-metadata-raw")
+
+# `records` can now be iterated through to access the individual elements.
+```
+
+
+## Developing
+
+### Running individual EC systems
+For each emergent language entry, we provide wrapper code (in
+`systems/*/code/`)  to create a reproducible environment and run the emergent
+language-generating code.  Environments are specified precisely in the
+`environment.yml` file; if you wish to edit the dependencies manually, it may
+be easier to start with `environment.editable.yml` instead, if it exists.
+Next, either run or look at `run.sh` or `run.py` to see the commands necessary
+to produce to the corpora.
 
 ### Git submodules
 This project uses git submodules to manage external dependencies.  Submodules

croissant.json

@@ -49,7 +49,7 @@
   "description": "ELCC is a collection of emergent language corpora with accompanying metadata and analyses.",
   "conformsTo": "http://mlcommons.org/croissant/1.0",
   "citeAs": "@misc{boldt2024elcc,\n  title = \"{ELCC}: the Emergent Language Corpus Collection\",\n  author = \"Brendon Boldt and David Mortensen\",\n  year = 2024,\n  url = \"https://huggingface.co/datasets/bboldt/elcc\",\n}",
-  "datePublished": "2024-06-13 07:19:21.844134+00:00",
+  "datePublished": "2024-06-13 07:25:44.022899+00:00",
   "keywords": [
     "emergent communication",
     "emergent language",
@@ -1142,9 +1142,6 @@
             },
             "extract": {
               "fileProperty": "fullpath"
-            },
-            "transform": {
-              "replace": "a"
             }
           }
         },

util/croissant.py

@@ -310,7 +310,8 @@ def test() -> None:
     # records = dataset.records(record_set="babyai-sr/GoToObj")
     # records = dataset.records(record_set="system-metadata")
     # records = dataset.records(record_set="system-metadata-raw")
-    records = dataset.records(record_set="corpus-metadata")
+    # records = dataset.records(record_set="corpus-metadata")
+    records = dataset.records(record_set="corpus-metadata-raw")
 
     for i, x in enumerate(records):
         print(i, x)
@@ -321,4 +322,4 @@ def test() -> None:
 
 if __name__ == "__main__":
     save_metadata()
-    test()
+    # test()

util/environment.export.yml

@@ -0,0 +1,79 @@
+name: elcc
+channels:
+- conda-forge
+dependencies:
+- _libgcc_mutex=0.1=conda_forge
+- _openmp_mutex=4.5=2_gnu
+- annotated-types=0.7.0=pyhd8ed1ab_0
+- black=24.4.2=py312h7900ff3_0
+- bzip2=1.0.8=hd590300_5
+- c-ares=1.28.1=hd590300_0
+- ca-certificates=2024.6.2=hbcca054_0
+- click=8.1.7=unix_pyh707e725_0
+- colorama=0.4.6=pyhd8ed1ab_0
+- git=2.45.1=pl5321hef9f9f3_0
+- git-lfs=3.5.1=ha770c72_0
+- jinja2=3.1.4=pyhd8ed1ab_0
+- joblib=1.4.2=pyhd8ed1ab_0
+- keyutils=1.6.1=h166bdaf_0
+- krb5=1.21.2=h659d440_0
+- ld_impl_linux-64=2.40=hf3520f5_2
+- libblas=3.9.0=22_linux64_openblas
+- libcblas=3.9.0=22_linux64_openblas
+- libcurl=8.8.0=hca28451_0
+- libedit=3.1.20191231=he28a2e2_2
+- libev=4.33=hd590300_2
+- libexpat=2.6.2=h59595ed_0
+- libffi=3.4.2=h7f98852_5
+- libgcc-ng=13.2.0=h77fa898_7
+- libgfortran-ng=13.2.0=h69a702a_7
+- libgfortran5=13.2.0=hca663fb_7
+- libgomp=13.2.0=h77fa898_7
+- libiconv=1.17=hd590300_2
+- liblapack=3.9.0=22_linux64_openblas
+- libnghttp2=1.58.0=h47da74e_1
+- libnsl=2.0.1=hd590300_0
+- libopenblas=0.3.27=pthreads_h413a1c8_0
+- libsqlite=3.45.3=h2797004_0
+- libssh2=1.11.0=h0841786_0
+- libstdcxx-ng=13.2.0=hc0a3c3a_7
+- libuuid=2.38.1=h0b41bf4_0
+- libxcrypt=4.4.36=hd590300_1
+- libzlib=1.3.1=h4ab18f5_1
+- markupsafe=2.1.5=py312h98912ed_0
+- mypy=1.10.0=py312h9a8786e_0
+- mypy_extensions=1.0.0=pyha770c72_0
+- ncurses=6.5=h59595ed_0
+- numpy=1.26.4=py312heda63a1_0
+- openssl=3.3.1=h4ab18f5_0
+- packaging=24.0=pyhd8ed1ab_0
+- pandas=2.2.2=py312h1d6d2e6_1
+- pandas-stubs=2.2.2.240603=pyhd8ed1ab_0
+- pathspec=0.12.1=pyhd8ed1ab_0
+- pcre2=10.43=hcad00b1_0
+- perl=5.32.1=7_hd590300_perl5
+- pip=24.0=pyhd8ed1ab_0
+- platformdirs=4.2.2=pyhd8ed1ab_0
+- psutil=5.9.8=py312h98912ed_0
+- pydantic=2.7.3=pyhd8ed1ab_0
+- pydantic-core=2.18.4=py312h4413252_0
+- python=3.12.3=hab00c5b_0_cpython
+- python-dateutil=2.9.0=pyhd8ed1ab_0
+- python-tzdata=2024.1=pyhd8ed1ab_0
+- python_abi=3.12=4_cp312
+- pytz=2024.1=pyhd8ed1ab_0
+- pyyaml=6.0.1=py312h98912ed_1
+- readline=8.2=h8228510_1
+- setuptools=70.0.0=pyhd8ed1ab_0
+- six=1.16.0=pyh6c4a22f_0
+- tk=8.6.13=noxft_h4845f30_101
+- tqdm=4.66.4=pyhd8ed1ab_0
+- types-pytz=2024.1.0.20240417=pyhd8ed1ab_0
+- typing-extensions=4.12.1=hd8ed1ab_0
+- typing_extensions=4.12.1=pyha770c72_0
+- tzdata=2024a=h0c530f3_0
+- wheel=0.43.0=pyhd8ed1ab_1
+- xz=5.2.6=h166bdaf_0
+- yaml=0.2.5=h7f98852_2
+- zstd=1.5.6=ha6fb4c9_0
+