Add raw system metadata

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 04:19:49.007677+00:00",
+  "datePublished": "2024-06-13 06:42:12.302053+00:00",
   "keywords": [
     "emergent communication",
     "emergent language",
@@ -77,6 +77,16 @@
       "encodingFormat": "application/json",
       "includes": "systems/*/system.json"
     },
+    {
+      "@type": "cr:FileSet",
+      "@id": "system-metadata-files-raw",
+      "name": "system-metadata-files-raw",
+      "containedIn": {
+        "@id": "repo"
+      },
+      "encodingFormat": "text/plain",
+      "includes": "systems/*/system.json"
+    },
     {
       "@type": "cr:FileObject",
       "@id": "systems/babyai-sr/data/GoToObj/corpus.json",
@@ -809,11 +819,65 @@
     }
   ],
   "recordSet": [
+    {
+      "@type": "cr:RecordSet",
+      "@id": "system-metadata-raw",
+      "name": "system-metadata-raw",
+      "field": [
+        {
+          "@type": "cr:Field",
+          "@id": "system-metadata-raw/path",
+          "name": "path",
+          "dataType": "sc:Text",
+          "references": {
+            "field": {
+              "@id": "system-metadata/path"
+            }
+          },
+          "source": {
+            "fileSet": {
+              "@id": "system-metadata-files-raw"
+            },
+            "extract": {
+              "fileProperty": "fullpath"
+            }
+          }
+        },
+        {
+          "@type": "cr:Field",
+          "@id": "system-metadata-raw/raw",
+          "name": "raw",
+          "dataType": "sc:Text",
+          "source": {
+            "fileSet": {
+              "@id": "system-metadata-files-raw"
+            },
+            "extract": {
+              "fileProperty": "content"
+            }
+          }
+        }
+      ]
+    },
     {
       "@type": "cr:RecordSet",
       "@id": "system-metadata",
       "name": "system-metadata",
       "field": [
+        {
+          "@type": "cr:Field",
+          "@id": "system-metadata/path",
+          "name": "path",
+          "dataType": "sc:Text",
+          "source": {
+            "fileSet": {
+              "@id": "system-metadata-files"
+            },
+            "extract": {
+              "fileProperty": "fullpath"
+            }
+          }
+        },
         {
           "@type": "cr:Field",
           "@id": "system-metadata/origin.name",
@@ -926,20 +990,6 @@
             }
           }
         },
-        {
-          "@type": "cr:Field",
-          "@id": "system-metadata/system.variants",
-          "name": "system.variants",
-          "dataType": "sc:Text",
-          "source": {
-            "fileSet": {
-              "@id": "system-metadata-files"
-            },
-            "extract": {
-              "jsonPath": "$.system.variants"
-            }
-          }
-        },
         {
           "@type": "cr:Field",
           "@id": "system-metadata/system.game_subtype",

util/croissant.py

@@ -27,6 +27,13 @@ _distribution: list[mlc.FileObject | mlc.FileSet] = [
         includes=["systems/*/system.json"],
         encoding_format="application/json",
     ),
+    mlc.FileSet(
+        id="system-metadata-files-raw",
+        name="system-metadata-files-raw",
+        contained_in=["repo"],
+        includes=["systems/*/system.json"],
+        encoding_format="text/plain",
+    ),
 ]
 
 _metadata = mlc.Metadata(
@@ -120,13 +127,51 @@ def make_system_field(base_name: str, typ: type | None) -> mlc.Field:
         source=mlc.Source(
             file_set="system-metadata-files",
             extract=mlc.Extract(json_path=jp),
-            # extract=mlc.Extract(file_property="filename"),
         ),
     )
 
 
 def insert_system_md(metadata: mlc.Metadata) -> None:
-    fields = []
+    metadata.record_sets.append(
+        mlc.RecordSet(
+            id="system-metadata-raw",
+            name="system-metadata-raw",
+            fields=[
+                mlc.Field(
+                    id="system-metadata-raw/path",
+                    name="path",
+                    data_types=[mlc.DataType.TEXT],
+                    source=mlc.Source(
+                        file_set="system-metadata-files-raw",
+                        extract=mlc.Extract(file_property=mlc.FileProperty.fullpath),
+                    ),
+                    # References always seem to cause conflicting read method errors.
+                    # references={"field": {"@id": "system-metadata/path"}},
+                ),
+                mlc.Field(
+                    id="system-metadata-raw/raw",
+                    name="raw",
+                    data_types=[mlc.DataType.TEXT],
+                    source=mlc.Source(
+                        file_set="system-metadata-files-raw",
+                        extract=mlc.Extract(file_property=mlc.FileProperty.content),
+                    ),
+                ),
+            ],
+        )
+    )
+
+    fields = [
+        mlc.Field(
+            id="system-metadata/path",
+            name="path",
+            data_types=[mlc.DataType.TEXT],
+            source=mlc.Source(
+                file_set="system-metadata-files",
+                extract=mlc.Extract(file_property=mlc.FileProperty.fullpath),
+            ),
+        ),
+    ]
     for k0, v0 in validate.SystemMetadata.model_fields.items():
         assert v0.annotation is not None
         if isinstance(v0.annotation, type) and issubclass(