Add corpus metadata to Croissant

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 06:42:12.302053+00:00",
+  "datePublished": "2024-06-13 07:19:21.844134+00:00",
   "keywords": [
     "emergent communication",
     "emergent language",
@@ -65,7 +65,7 @@
       "name": "repo",
       "contentUrl": "https://huggingface.co/datasets/bboldt/elcc/",
       "encodingFormat": "git+https",
-      "sha256": "b3c660db198ddca4cf1de63a4dbb0ecb573d28a3"
+      "sha256": "main"
     },
     {
       "@type": "cr:FileSet",
@@ -87,6 +87,26 @@
       "encodingFormat": "text/plain",
       "includes": "systems/*/system.json"
     },
+    {
+      "@type": "cr:FileSet",
+      "@id": "corpus-metadata-files",
+      "name": "corpus-metadata-files",
+      "containedIn": {
+        "@id": "repo"
+      },
+      "encodingFormat": "application/json",
+      "includes": "systems/*/data/*/metadata.json"
+    },
+    {
+      "@type": "cr:FileSet",
+      "@id": "corpus-metadata-files-raw",
+      "name": "corpus-metadata-files-raw",
+      "containedIn": {
+        "@id": "repo"
+      },
+      "encodingFormat": "text/plain",
+      "includes": "systems/*/data/*/metadata.json"
+    },
     {
       "@type": "cr:FileObject",
       "@id": "systems/babyai-sr/data/GoToObj/corpus.json",
@@ -829,11 +849,6 @@
           "@id": "system-metadata-raw/path",
           "name": "path",
           "dataType": "sc:Text",
-          "references": {
-            "field": {
-              "@id": "system-metadata/path"
-            }
-          },
           "source": {
             "fileSet": {
               "@id": "system-metadata-files-raw"
@@ -1076,6 +1091,247 @@
         }
       ]
     },
+    {
+      "@type": "cr:RecordSet",
+      "@id": "corpus-metadata-raw",
+      "name": "corpus-metadata-raw",
+      "field": [
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata-raw/path",
+          "name": "path",
+          "dataType": "sc:Text",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files-raw"
+            },
+            "extract": {
+              "fileProperty": "fullpath"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata-raw/raw",
+          "name": "raw",
+          "dataType": "sc:Text",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files-raw"
+            },
+            "extract": {
+              "fileProperty": "content"
+            }
+          }
+        }
+      ]
+    },
+    {
+      "@type": "cr:RecordSet",
+      "@id": "corpus-metadata",
+      "name": "corpus-metadata",
+      "field": [
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/path",
+          "name": "path",
+          "dataType": "sc:Text",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "fileProperty": "fullpath"
+            },
+            "transform": {
+              "replace": "a"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.token_count",
+          "name": "metrics.analysis.token_count",
+          "dataType": "sc:Integer",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"Token Count\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.line_count",
+          "name": "metrics.analysis.line_count",
+          "dataType": "sc:Integer",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"Line Count\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.tokens_per_line",
+          "name": "metrics.analysis.tokens_per_line",
+          "dataType": "sc:Float",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"Tokens per Line\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.tokens_per_line_sd",
+          "name": "metrics.analysis.tokens_per_line_sd",
+          "dataType": "sc:Float",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"Tokens per Line SD\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.unique_tokens",
+          "name": "metrics.analysis.unique_tokens",
+          "dataType": "sc:Integer",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"Unique Tokens\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.unique_lines",
+          "name": "metrics.analysis.unique_lines",
+          "dataType": "sc:Integer",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"Unique Lines\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.1-gram_entropy",
+          "name": "metrics.analysis.1-gram_entropy",
+          "dataType": "sc:Float",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"1-gram Entropy\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.1-gram_normalized_entropy",
+          "name": "metrics.analysis.1-gram_normalized_entropy",
+          "dataType": "sc:Float",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"1-gram Normalized Entropy\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.2-gram_entropy",
+          "name": "metrics.analysis.2-gram_entropy",
+          "dataType": "sc:Float",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"2-gram Entropy\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.2-gram_conditional_entropy",
+          "name": "metrics.analysis.2-gram_conditional_entropy",
+          "dataType": "sc:Float",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"2-gram Conditional Entropy\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.entropy_per_line",
+          "name": "metrics.analysis.entropy_per_line",
+          "dataType": "sc:Float",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"Entropy per Line\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.eos_token_present",
+          "name": "metrics.analysis.eos_token_present",
+          "dataType": "sc:Integer",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"EoS Token Present\"]"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "corpus-metadata/metrics.analysis.eos_padding",
+          "name": "metrics.analysis.eos_padding",
+          "dataType": "sc:Integer",
+          "source": {
+            "fileSet": {
+              "@id": "corpus-metadata-files"
+            },
+            "extract": {
+              "jsonPath": "$.metrics.analysis[\"EoS Padding\"]"
+            }
+          }
+        }
+      ]
+    },
     {
       "@type": "cr:RecordSet",
       "@id": "babyai-sr/GoToObj",

util/croissant.py

@@ -17,8 +17,7 @@ _distribution: list[mlc.FileObject | mlc.FileSet] = [
         name="repo",
         content_url="https://huggingface.co/datasets/bboldt/elcc/",
         encoding_format="git+https",
-        # sha256="main",
-        sha256="b3c660db198ddca4cf1de63a4dbb0ecb573d28a3",
+        sha256="main",
     ),
     mlc.FileSet(
         id="system-metadata-files",
@@ -34,6 +33,20 @@ _distribution: list[mlc.FileObject | mlc.FileSet] = [
         includes=["systems/*/system.json"],
         encoding_format="text/plain",
     ),
+    mlc.FileSet(
+        id="corpus-metadata-files",
+        name="corpus-metadata-files",
+        contained_in=["repo"],
+        includes=["systems/*/data/*/metadata.json"],
+        encoding_format="application/json",
+    ),
+    mlc.FileSet(
+        id="corpus-metadata-files-raw",
+        name="corpus-metadata-files-raw",
+        contained_in=["repo"],
+        includes=["systems/*/data/*/metadata.json"],
+        encoding_format="text/plain",
+    ),
 ]
 
 _metadata = mlc.Metadata(
@@ -196,9 +209,89 @@ def insert_system_md(metadata: mlc.Metadata) -> None:
     )
 
 
+def insert_corpus_md(metadata: mlc.Metadata) -> None:
+    metadata.record_sets.append(
+        mlc.RecordSet(
+            id="corpus-metadata-raw",
+            name="corpus-metadata-raw",
+            fields=[
+                mlc.Field(
+                    id="corpus-metadata-raw/path",
+                    name="path",
+                    data_types=[mlc.DataType.TEXT],
+                    source=mlc.Source(
+                        file_set="corpus-metadata-files-raw",
+                        extract=mlc.Extract(file_property=mlc.FileProperty.fullpath),
+                    ),
+                    # References always seem to cause conflicting read method errors.
+                    # references={"field": {"@id": "corpus-metadata/path"}},
+                ),
+                mlc.Field(
+                    id="corpus-metadata-raw/raw",
+                    name="raw",
+                    data_types=[mlc.DataType.TEXT],
+                    source=mlc.Source(
+                        file_set="corpus-metadata-files-raw",
+                        extract=mlc.Extract(file_property=mlc.FileProperty.content),
+                    ),
+                ),
+            ],
+        )
+    )
+
+    exemplar_path = "systems/nav-to-center/data/temperature_10/metadata.json"
+    with open(exemplar_path) as fo:
+        exemplar_data = json.load(fo)
+    fields = [
+        mlc.Field(
+            id="corpus-metadata/path",
+            name="path",
+            data_types=[mlc.DataType.TEXT],
+            source=mlc.Source(
+                file_set="corpus-metadata-files",
+                extract=mlc.Extract(file_property=mlc.FileProperty.fullpath),
+                # transforms=[mlc.Transform(regex=r"(....)")],
+            ),
+            # References always seem to cause conflicting read method errors.
+            # references={"field": {"@id": "corpus-metadata/path"}},
+        ),
+    ]
+    items = exemplar_data["metrics"]["analysis"].items()
+    for k, v in items:
+        name = f"metrics.analysis.{k}".replace(" ", "_").lower()
+        if isinstance(v, int):
+            typ = mlc.DataType.INTEGER
+        elif isinstance(v, bool):
+            typ = mlc.DataType.BOOL
+        else:
+            typ = mlc.DataType.FLOAT
+        jp = f'$.metrics.analysis["{k}"]'
+        fields.append(
+            mlc.Field(
+                id=f"corpus-metadata/{name}",
+                name=name,
+                data_types=[typ],
+                source=mlc.Source(
+                    file_set="corpus-metadata-files",
+                    # extract=mlc.Extract(file_property=mlc.FileProperty.fullpath),
+                    extract=mlc.Extract(json_path=jp),
+                ),
+            )
+        )
+
+    metadata.record_sets.append(
+        mlc.RecordSet(
+            id="corpus-metadata",
+            name="corpus-metadata",
+            fields=fields,
+        )
+    )
+
+
 @functools.cache
 def get_metadata() -> mlc.Metadata:
     insert_system_md(_metadata)
+    insert_corpus_md(_metadata)
     insert_corpora(_metadata)
     return _metadata
 
@@ -215,12 +308,14 @@ def save_metadata() -> None:
 def test() -> None:
     dataset = mlc.Dataset(jsonld="croissant.json")
     # records = dataset.records(record_set="babyai-sr/GoToObj")
-    records = dataset.records(record_set="system-metadata")
+    # records = dataset.records(record_set="system-metadata")
+    # records = dataset.records(record_set="system-metadata-raw")
+    records = dataset.records(record_set="corpus-metadata")
 
     for i, x in enumerate(records):
         print(i, x)
         if i > 10:
-            # break
+            break
             pass