Add v20230518 release file

README.md

@@ -75,7 +75,7 @@ Please check the exemplar usage below for loading the data:
 ```python
 from datasets import load_dataset
 
-multi_lexsum = load_dataset("allenai/multi_lexsum", name="v20220616")
+multi_lexsum = load_dataset("allenai/multi_lexsum", name="v20230518")
 # Download multi_lexsum locally and load it as a Dataset object 
 
 example = multi_lexsum["validation"][0] # The first instance of the dev set 
@@ -83,6 +83,8 @@ example["sources"] # A list of source document text for the case
 
 for sum_len in ["long", "short", "tiny"]:
     print(example["summary/" + sum_len]) # Summaries of three lengths
+
+  print(example['case_metadata']) # The corresponding metadata for a case in a dict 
 ```
 
 ### Data Splits
@@ -125,7 +127,7 @@ The corresponding code for downloading and loading the dataset is licensed under
   title     = {Multi-LexSum: Real-World Summaries of Civil Rights Lawsuits at Multiple Granularities},
   journal   = {CoRR},
   volume    = {abs/2206.10883},
-  year      = {2022},
+  year      = {2022},****
   url       = {https://doi.org/10.48550/arXiv.2206.10883},
   doi       = {10.48550/arXiv.2206.10883}
 }
@@ -134,6 +136,7 @@ The corresponding code for downloading and loading the dataset is licensed under
 
 ## Release History 
 
-|     Version |              Description |
-| ----------: | -----------------------: |
-| `v20220616` | The initial v1.0 release |
+|     Version |                                                  Description |
+| ----------: | -----------------------------------------------------------: |
+| `v20230518` | The v1.1 release including case and source document metadata |
+| `v20220616` |                                     The initial v1.0 release |

multi_lexsum.py

@@ -1,6 +1,6 @@
-from typing import List, Union, Dict, Any, Tuple
 import json
 import os
+from typing import Any, Dict, List, Tuple, Union
 
 import datasets
 from datasets.tasks import Summarization
@@ -17,7 +17,6 @@ def _load_jsonl(filename):
 
 
 def _load_json(filepath):
-
     with open(filepath, "r") as fp:
         res = json.load(fp)
     return res
@@ -42,7 +41,7 @@ _CITATION = """
 
 _DESCRIPTION = """
 Multi-LexSum is a multi-doc summarization dataset for civil rights litigation lawsuits with summaries of three granularities. 
-"""  # TODO: Update with full abstract 
+"""  # TODO: Update with full abstract
 
 _HOMEPAGE = "https://multilexsum.github.io"
 
@@ -68,8 +67,8 @@ class MultiLexsumConfig(datasets.BuilderConfig):
 
 
 class MultiLexsum(datasets.GeneratorBasedBuilder):
-    """MultiLexSum Dataset: a multi-doc summarization dataset for 
-    civil rights litigation lawsuits with summaries of three granularities. 
+    """MultiLexSum Dataset: a multi-doc summarization dataset for
+    civil rights litigation lawsuits with summaries of three granularities.
     """
 
     BUILDER_CONFIGS = [
@@ -78,30 +77,90 @@ class MultiLexsum(datasets.GeneratorBasedBuilder):
             version=datasets.Version("1.0.0", "Public v1.0 release."),
             description="The v1.0 Multi-LexSum dataset",
         ),
+        MultiLexsumConfig(
+            name="v20230518",
+            version=datasets.Version("1.1.0", "Public v1.1 release."),
+            description="It adds additional metadata for documents and cases",
+        ),
     ]
 
     def _info(self):
-        return datasets.DatasetInfo(
-            description=_DESCRIPTION,
-            features=datasets.Features(
-                {
-                    "id": datasets.Value("string"),
-                    "sources": datasets.Sequence(datasets.Value("string")),
-                    "summary/long": datasets.Value("string"),
-                    "summary/short": datasets.Value("string"),
-                    "summary/tiny": datasets.Value("string"),
-                }
-            ),
-            supervised_keys=None,
-            homepage=_HOMEPAGE,
-            citation=_CITATION,
-            task_templates=[
-                Summarization(text_column="source", summary_column="summary/long")
-            ],
-        )
+        if self.config.name == "v20220616":
+            return datasets.DatasetInfo(
+                description=_DESCRIPTION,
+                features=datasets.Features(
+                    {
+                        "id": datasets.Value("string"),
+                        "sources": datasets.Sequence(datasets.Value("string")),
+                        "summary/long": datasets.Value("string"),
+                        "summary/short": datasets.Value("string"),
+                        "summary/tiny": datasets.Value("string"),
+                    }
+                ),
+                supervised_keys=None,
+                homepage=_HOMEPAGE,
+                citation=_CITATION,
+                task_templates=[
+                    Summarization(text_column="source", summary_column="summary/long")
+                ],
+            )
+        elif self.config.name == "v20230518":
+            return datasets.DatasetInfo(
+                description=_DESCRIPTION,
+                features=datasets.Features(
+                    {
+                        "id": datasets.Value("string"),
+                        "sources": datasets.Sequence(datasets.Value("string")),
+                        "sources_metadata": datasets.Sequence(
+                            {
+                                "doc_id": datasets.Value("string"),
+                                "doc_type": datasets.Value("string"),
+                                "doc_title": datasets.Value("string"),
+                                "parser": datasets.Value("string"),
+                                "is_ocr": datasets.Value("bool"),
+                                "url": datasets.Value("string"),
+                            }
+                        ),
+                        "summary/long": datasets.Value("string"),
+                        "summary/short": datasets.Value("string"),
+                        "summary/tiny": datasets.Value("string"),
+                        "case_metadata": datasets.Features(
+                            {
+                                # fmt: off
+                            "case_name": datasets.Value("string"),
+                            "case_type": datasets.Value("string"),
+                            "filing_date": datasets.Value("string"),
+                            "filing_year": datasets.Value("string"),
+                            "case_ongoing": datasets.Value("string"),
+                            "case_ongoing_record_time": datasets.Value("string"),
+                            "closing_year": datasets.Value("string"),
+                            "order_start_year": datasets.Value("string"),
+                            "order_end_year": datasets.Value("string"),
+                            "defendant_payment": datasets.Value("string"),
+                            "class_action_sought": datasets.Value("string"),
+                            "class_action_granted": datasets.Value("string"),
+                            "attorney_orgs": [datasets.Value("string")],
+                            "prevailing_party": datasets.Value("string"),
+                            "plaintiff_types": [datasets.Value("string")],
+                            "plaintiff_description": datasets.Value("string"),
+                            "constitutional_clauses": [datasets.Value("string")],
+                            "causes_of_action": [datasets.Value("string")],
+                            "summary_authors": [datasets.Value("string")],
+                            "case_url": datasets.Value("string"),
+                                # fmt: on
+                            }
+                        ),
+                    }
+                ),
+                supervised_keys=None,
+                homepage=_HOMEPAGE,
+                citation=_CITATION,
+                task_templates=[
+                    Summarization(text_column="source", summary_column="summary/long")
+                ],
+            )
 
     def _split_generators(self, dl_manager):
-
         base_url = _BASE_URL if self.config.data_dir is None else self.config.data_dir
         downloaded_files = dl_manager.download_and_extract(
             {
@@ -140,16 +199,67 @@ class MultiLexsum(datasets.GeneratorBasedBuilder):
         """This function returns the examples in the raw (text) form."""
         logger.info(f"generating examples from = {subset_file}")
 
-        subset_cases = _load_jsonl(subset_file)
-        for case_data in subset_cases:
-            case_sources = [
-                sources[source_id]["doc_text"]
-                for source_id in case_data["case_documents"]
-            ]
-            yield case_data["case_id"], {
-                "id": case_data["case_id"],
-                "sources": case_sources,
-                "summary/long": case_data["summary/long"],
-                "summary/short": case_data["summary/short"],
-                "summary/tiny": case_data["summary/tiny"],
-            }
+        if self.config.name == "v20220616":
+            subset_cases = _load_jsonl(subset_file)
+            for case_data in subset_cases:
+                case_sources = [
+                    sources[source_id]["doc_text"]
+                    for source_id in case_data["case_documents"]
+                ]
+                yield case_data["case_id"], {
+                    "id": case_data["case_id"],
+                    "sources": case_sources,
+                    "summary/long": case_data["summary/long"],
+                    "summary/short": case_data["summary/short"],
+                    "summary/tiny": case_data["summary/tiny"],
+                }
+        elif self.config.name == "v20230518":
+            subset_cases = _load_jsonl(subset_file)
+
+            for idx, case_data in enumerate(subset_cases):
+                case_sources = [
+                    sources[source_id]["doc_text"]
+                    for source_id in case_data["case_documents"]
+                ]
+
+                case_source_metadata = [
+                    {
+                        key: val
+                        for key, val in sources[source_id].items()
+                        if key != "doc_text"
+                    }
+                    for source_id in case_data["case_documents"]
+                ]
+
+                case_metadata = {
+                    "case_name": case_data["case_name"],
+                    "case_type": case_data["case_type"],
+                    "filing_date": case_data["filing_date"],
+                    "filing_year": case_data["filing_year"],
+                    "case_ongoing": case_data["case_ongoing"],
+                    "case_ongoing_record_time": case_data["case_ongoing_record_time"],
+                    "closing_year": case_data["closing_year"],
+                    "order_start_year": case_data["order_start_year"],
+                    "order_end_year": case_data["order_end_year"],
+                    "defendant_payment": case_data["defendant_payment"],
+                    "class_action_sought": case_data["class_action_sought"],
+                    "class_action_granted": case_data["class_action_granted"],
+                    "attorney_orgs": case_data["attorney_org"],
+                    "prevailing_party": case_data["prevailing_party"],
+                    "plaintiff_types": case_data["plaintiff_types"],
+                    "plaintiff_description": case_data["plaintiff_description"],
+                    "constitutional_clauses": case_data["constitutional_clauses"],
+                    "causes_of_action": case_data["causes_of_action"],
+                    "summary_authors": case_data["summary_authors"],
+                    "case_url": case_data["case_url"],
+                }
+
+                yield case_data["case_id"], {
+                    "id": case_data["case_id"],
+                    "sources": case_sources,
+                    "sources_metadata": case_source_metadata,
+                    "summary/long": case_data["summary/long"],
+                    "summary/short": case_data["summary/short"],
+                    "summary/tiny": case_data["summary/tiny"],
+                    "case_metadata": case_metadata,
+                }

releases/v20230518/dev.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0ae6fe46c5557975b29ed5bbfe780e9d188623320ac6c94d75ea8412ffe64b31
+size 2555645

releases/v20230518/sources.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:805fd58ac5f72c40c9b575fa1e1b0be1943ea3c07a1a3089827444a3e0abc858
+size 2221892187

releases/v20230518/test.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:56ffcfc1add9fbd895b024d1220317acb25109508ea76f275952ca8419594e61
+size 4821719

releases/v20230518/train.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:168c1c22fb4739e4cb0405bfc29499744357218a386d9bc234c0dfc39f0c1302
+size 17628135