Changed data

demo.ipynb

@@ -20,7 +20,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 21,
+   "execution_count": 28,
    "id": "2cb75e7c-b7eb-4601-85f3-cc27c1f5ff94",
    "metadata": {},
    "outputs": [
@@ -28,21 +28,21 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "Downloading builder script: 100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 3.64k/3.64k [00:00<00:00, 14.5MB/s]\n"
+      "Downloading builder script: 100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 3.67k/3.67k [00:00<00:00, 11.9MB/s]\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Downloading and preparing dataset housing_qa/questions (download: 963.72 KiB, generated: 18.27 MiB, post-processed: Unknown size, total: 19.21 MiB) to /Users/neelguha/.cache/huggingface/datasets/reglab___housing_qa/questions/1.0.0/8bf686206d753eb1bc023c1aa0b7841398d312cdf6a0e537f27fb74f6eab4eef...\n"
+      "Downloading and preparing dataset housing_qa/questions (download: 963.72 KiB, generated: 18.27 MiB, post-processed: Unknown size, total: 19.21 MiB) to /Users/neelguha/.cache/huggingface/datasets/reglab___housing_qa/questions/1.0.0/72d4d5c21c6043dceebcc4cb378b5258ba6b3c0db013d32c0627b85a4c6f50bc...\n"
      ]
     },
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "Downloading data: 100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 987k/987k [00:00<00:00, 5.73MB/s]\n",
+      "Downloading data: 100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 987k/987k [00:00<00:00, 7.34MB/s]\n",
       "                                                                                                                                                                                                \r"
      ]
     },
@@ -50,7 +50,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Dataset housing_qa downloaded and prepared to /Users/neelguha/.cache/huggingface/datasets/reglab___housing_qa/questions/1.0.0/8bf686206d753eb1bc023c1aa0b7841398d312cdf6a0e537f27fb74f6eab4eef. Subsequent calls will reuse this data.\n"
+      "Dataset housing_qa downloaded and prepared to /Users/neelguha/.cache/huggingface/datasets/reglab___housing_qa/questions/1.0.0/72d4d5c21c6043dceebcc4cb378b5258ba6b3c0db013d32c0627b85a4c6f50bc. Subsequent calls will reuse this data.\n"
      ]
     },
     {
@@ -174,7 +174,7 @@
        "4  [A landlord waives their right to evict by acc...  "
       ]
      },
-     "execution_count": 21,
+     "execution_count": 28,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -186,32 +186,43 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 23,
+   "execution_count": 30,
    "id": "3931e731-006f-4731-8350-a7f83ea3f298",
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "{'idx': 0,\n",
+       "{'idx': 237,\n",
        " 'state': 'Alabama',\n",
-       " 'question': 'Is there a state/territory law regulating residential evictions?',\n",
+       " 'question': 'Does the law specify rebuttals available to tenants subject to eviction proceedings?',\n",
        " 'answer': 'Yes',\n",
-       " 'question_group': 69,\n",
-       " 'statutes': {'statute_idx': [431263],\n",
-       "  'citation': ['ALA. CODE § 35-9A-141(11)'],\n",
-       "  'excerpt': ['(11) “premises” means a dwelling unit and the structure of which it is a part and facilities and appurtenances therein and grounds, areas, and facilities held out for the use of tenants generally or whose use is promised by the rental agreement to the tenant;']},\n",
-       " 'original_question': 'Is there a state/territory law regulating residential evictions?',\n",
+       " 'question_group': 116,\n",
+       " 'statutes': {'statute_idx': [417060, 431274, 431280, 431273, 431271],\n",
+       "  'citation': ['ALA. CODE § 35-9A-501(B)',\n",
+       "   'ALA. CODE § 35-9A-405(A)',\n",
+       "   'ALA. CODE § 35-9A-424',\n",
+       "   'ALA. CODE § 35-9A-404(B)',\n",
+       "   'ALA. CODE § 35-9A-401(A)'],\n",
+       "  'excerpt': ['(b) If a landlord acts in violation of subsection (a), the tenant is entitled to the remedies provided in Section 35-9A-407 and has a defense in any retaliatory action against the tenant for possession.',\n",
+       "   \"(a) In an action for possession or in an action for rent when the tenant is in possession, the tenant may counterclaim for any amount the tenant may recover under the rental agreement or this chapter. It is in the court's discretion whether the tenant is to remain in possession. The tenant shall pay into court rent accrued and thereafter accruing as it comes due. The court shall determine the amount due to each party. The party to whom a net amount is owed shall be paid first from the money paid into court, and the balance by the other party. If no rent remains due after application of this section, judgment shall be entered for the tenant in the action for possession. If the defense or counterclaim by the tenant is without merit and is not raised in good faith, the landlord may recover reasonable attorney's fees.\",\n",
+       "   \"Acceptance of rent with knowledge of a default by the tenant or acceptance of performance by the tenant that varies from the terms of the rental agreement constitutes a waiver of the landlord's right to terminate the rental agreement for that breach, unless otherwise agreed after the breach has occurred.\",\n",
+       "   '(b) If contrary to the rental agreement or Section 35-9A-204, after receiving notice of the breach from the tenant, the landlord willfully or negligently fails to promptly make available heat, running water, hot water, electric, gas, or other essential service, the tenant may:(1) send a written notice specifying the date of termination not less than 14 days after receipt of notice and upon vacation of the premises, the rental agreement shall be rightfully terminated without further obligation or penalty. If the rental agreement is terminated pursuant to this section, the landlord shall return all security recoverable by the tenant under Section 35-9A-201 and all unearned prepaid rent; or(2) recover damages based upon the diminution in the fair rental value of the dwelling unit.',\n",
+       "   '(a) Except as provided in this chapter, if there is a material noncompliance by the landlord with the rental agreement or a noncompliance with Section 35-9A-204 materially affecting health and safety, the tenant may deliver a written notice to the landlord specifying the acts and omissions constituting the breach and that the rental agreement will terminate upon a date not less than 14 days after receipt of the notice if the breach is not remedied within that period, and the rental agreement shall terminate as provided in the notice subject to the following:']},\n",
+       " 'original_question': 'Does the law specify rebuttals available to a tenant?',\n",
        " 'caveats': ['']}"
       ]
      },
-     "execution_count": 23,
+     "execution_count": 30,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "questions[0]"
+    "for q in questions:\n",
+    "    if len(q[\"statutes\"][\"citation\"]) > 1:\n",
+    "        break \n",
+    "q"
    ]
   },
   {

housing_qa.py

@@ -1,7 +1,7 @@
 import csv
 
 import datasets
-from datasets import Features, Value, Sequence, features
+from datasets import Dataset, DatasetInfo, Features, ClassLabel, Value, Sequence, DatasetDict
 import json
 from io import StringIO
 from pathlib import Path
@@ -20,38 +20,37 @@ _CONFIGS = {}
 
 _CONFIGS["questions"] = {
     "description": "Questions about housing law.",
-    "features": Features({
-        "idx": Value("int32"),
-        "state": Value("string"),
-        "question": Value("string"),
-        "answer": Value("string"),
-        "question_group": Value("int32"),
-        "statutes": features.Sequence(feature={
-            "statute_idx": Value("int32"),
-            "citation": Value("string"),
-            "excerpt": Value("string")
+    "features" : Features({
+        'idx': Value('int32'),
+        'state': Value('string'),
+        'question': Value('string'),
+        'answer': Value('string'),
+        'question_group': Value('int32'),
+        'statutes': Sequence({
+            'statute_idx': Value('int32'),
+            'citation': Value('string'),
+            'excerpt': Value('string'),
         }),
-        "original_question": Value("string"),
-        "caveats": Sequence(Value("string")),
+        'original_question': Value('string'),
+        'caveats': Sequence(Value('string')),
     }),
     "license": None,
-    "license": None,
 }
 
 _CONFIGS["questions_aux"] = {
     "description": "An auxilliary set of larger questions about housing law, without statutory annotations.",
-    "features": Features({
-        "idx": Value("int32"),
-        "state": Value("string"),
-        "question": Value("string"),
-        "answer": Value("string"),
-        "question_group": Value("int32"),
-        "statutes": features.Sequence({
-            "citation": Value("string"),
-            "excerpt": Value("string")
+    "features" : Features({
+        'idx': Value('int32'),
+        'state': Value('string'),
+        'question': Value('string'),
+        'answer': Value('string'),
+        'question_group': Value('int32'),
+        'statutes': Sequence({
+            'citation': Value('string'),
+            'excerpt': Value('string'),
         }),
-        "original_question": Value("string"),
-        "caveats": Sequence(Value("string")),
+        'original_question': Value('string'),
+        'caveats': Sequence(Value('string')),
     }),
     "license": None,
 }

statistics.ipynb

@@ -2,28 +2,64 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 22,
-   "id": "fce498ac-4ea7-4e10-a15a-60ac41e3adce",
+   "execution_count": 26,
+   "id": "2c24819e-0019-4c60-9284-77bfa565ecc5",
    "metadata": {},
    "outputs": [],
    "source": [
-    "from datasets import load_dataset\n",
-    "from collections import Counter"
+    "from datasets import Dataset, DatasetInfo, Features, ClassLabel, Value, Sequence, DatasetDict\n",
+    "\n",
+    "# Define the dataset's schema\n",
+    "features = Features({\n",
+    "    'idx': Value('int32'),\n",
+    "    'state': Value('string'),\n",
+    "    'question': Value('string'),\n",
+    "    'answer': Value('string'),\n",
+    "    'question_group': Value('int32'),\n",
+    "    'statutes': Sequence({\n",
+    "        'statute_idx': Value('int32'),\n",
+    "        'citation': Value('string'),\n",
+    "        'excerpt': Value('string'),\n",
+    "    }),\n",
+    "    'original_question': Value('string'),\n",
+    "    'caveats': Sequence(Value('string')),\n",
+    "})\n",
+    "\n",
+    "# Create a DatasetInfo object for additional metadata\n",
+    "dataset_info = DatasetInfo(\n",
+    "    description=\"A dataset containing information on state/territory laws regulating residential evictions, including relevant legal statutes.\",\n",
+    "    features=features,\n",
+    "    supervised_keys=None,  # No supervised keys as this dataset doesn't include labels for training models\n",
+    "    homepage=\"http://example.com\",  # Add a real homepage if applicable\n",
+    "    citation=\"Citation information for the dataset\",\n",
+    ")\n",
+    "\n",
+    "# Load dataset from your data source\n",
+    "# Assuming your data is in JSON or other format, use appropriate loading function\n",
+    "dataset = DatasetDict({\n",
+    "    'train': Dataset.from_dict({\n",
+    "        'idx': [0],\n",
+    "        'state': ['Alabama'],\n",
+    "        'question': ['Is there a state/territory law regulating residential evictions?'],\n",
+    "        'answer': ['Yes'],\n",
+    "        'question_group': [69],\n",
+    "        'statutes': [[{\n",
+    "            'statute_idx': 431263,\n",
+    "            'citation': 'ALA. CODE \\u00a7 35-9A-141(11)',\n",
+    "            'excerpt': '(11) “premises” means a dwelling unit and the structure of which it is a part and facilities and appurtenances therein and grounds, areas, and facilities held out for the use of tenants generally or whose use is promised by the rental agreement to the tenant;',\n",
+    "        }]],\n",
+    "        'original_question': ['Is there a state/territory law regulating residential evictions?'],\n",
+    "        'caveats': [['']],\n",
+    "    })\n",
+    "})"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 23,
-   "id": "73aaafd1-3ebb-42f7-b162-2e6bc630d195",
+   "execution_count": 29,
+   "id": "893dbd5a-e351-43a9-b939-ed022a78b78a",
    "metadata": {},
    "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "Found cached dataset housing_qa (/Users/neelguha/.cache/huggingface/datasets/reglab___housing_qa/questions/1.0.0/c3f397c8b54111729d49ff66d6145d407a535b137643491f86e3dc7b858cf34a)\n"
-     ]
-    },
     {
      "data": {
       "text/plain": [
@@ -32,70 +68,26 @@
        " 'question': 'Is there a state/territory law regulating residential evictions?',\n",
        " 'answer': 'Yes',\n",
        " 'question_group': 69,\n",
-       " 'statutes': {'statute_idx': [431263],\n",
-       "  'citation': ['ALA. CODE § 35-9A-141(11)'],\n",
-       "  'excerpt': ['(11) “premises” means a dwelling unit and the structure of which it is a part and facilities and appurtenances therein and grounds, areas, and facilities held out for the use of tenants generally or whose use is promised by the rental agreement to the tenant;']},\n",
+       " 'statutes': [{'citation': 'ALA. CODE § 35-9A-141(11)',\n",
+       "   'excerpt': '(11) “premises” means a dwelling unit and the structure of which it is a part and facilities and appurtenances therein and grounds, areas, and facilities held out for the use of tenants generally or whose use is promised by the rental agreement to the tenant;',\n",
+       "   'statute_idx': 431263}],\n",
        " 'original_question': 'Is there a state/territory law regulating residential evictions?',\n",
        " 'caveats': ['']}"
       ]
      },
-     "execution_count": 23,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "questions = load_dataset(\"reglab/housing_qa\", \"questions\", split=\"test\")\n",
-    "questions[0]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 24,
-   "id": "c28a88fe-933f-424c-9b81-fc43eea34dee",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "counts = []\n",
-    "for sample in questions: \n",
-    "    if len(sample[\"caveats\"][0]) > 0:\n",
-    "        break "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 25,
-   "id": "2c24819e-0019-4c60-9284-77bfa565ecc5",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'idx': 353,\n",
-       " 'state': 'Alabama',\n",
-       " 'question': 'Is it specified whether a landlord waives their right to evict for nonpayment of rent by accepting partial payment of rent?',\n",
-       " 'answer': 'Yes',\n",
-       " 'question_group': 201,\n",
-       " 'statutes': {'statute_idx': [431280],\n",
-       "  'citation': ['ALA. CODE § 35-9A-424'],\n",
-       "  'excerpt': [\"Acceptance of rent with knowledge of a default by the tenant or acceptance of performance by the tenant that varies from the terms of the rental agreement constitutes a waiver of the landlord's right to terminate the rental agreement for that breach, unless otherwise agreed after the breach has occurred.\"]},\n",
-       " 'original_question': 'Does a landlord waive their right to evict for nonpayment of rent by accepting partial payment of rent?',\n",
-       " 'caveats': ['A landlord waives their right to evict by accepting payment of rent, Ala. Code § 35-9A-424, but the law does not specify whether acceptance of full or partial payment is required for the waiver.']}"
-      ]
-     },
-     "execution_count": 25,
+     "execution_count": 29,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "sample"
+    "dataset[\"train\"][0]"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "893dbd5a-e351-43a9-b939-ed022a78b78a",
+   "id": "98fc7ef8-24e8-4e02-ba9f-215330fca3c6",
    "metadata": {},
    "outputs": [],
    "source": []