README update

README.md

@@ -1,5 +1,15 @@
 ---
 license: mit
+language:
+  - en
+multilinguality:
+  - monolingual
+size_categories:
+  - 1K<n<10K
+source_datasets:
+  - original
+task_categories:
+  - text2text-generation
 dataset_info:
   features:
   - name: Text
@@ -18,5 +28,11 @@ dataset_info:
 
 # Contextual Semantic Labels (Large) Benchmark Dataset
 
-Please see https://github.com/docugami/DFM-benchmarks for more details, eval code, and current scores for different models.
+Please see [https://github.com/docugami/DFM-benchmarks](https://github.com/docugami/DFM-benchmarks) for more details, eval code, and current scores for different models.
+
+# Using Dataset
+
+Please refer to standard huggingface documentation to use this dataset: [https://huggingface.co/docs/datasets/index](https://huggingface.co/docs/datasets/index)
+
+The [explore.ipynb](./explore.ipynb) notebook has some reference code.
 

explore.ipynb

@@ -12,7 +12,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -21,95 +21,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Requirement already satisfied: datasets in /usr/local/lib/python3.9/dist-packages (2.12.0)\n",
-      "Requirement already satisfied: huggingface_hub in /usr/local/lib/python3.9/dist-packages (0.14.1)\n",
-      "Requirement already satisfied: ipywidgets in /usr/local/lib/python3.9/dist-packages (8.0.6)\n",
-      "Requirement already satisfied: pyarrow>=8.0.0 in /usr/local/lib/python3.9/dist-packages (from datasets) (12.0.0)\n",
-      "Requirement already satisfied: xxhash in /usr/local/lib/python3.9/dist-packages (from datasets) (3.2.0)\n",
-      "Requirement already satisfied: packaging in /root/.local/lib/python3.9/site-packages (from datasets) (23.1)\n",
-      "Requirement already satisfied: dill<0.3.7,>=0.3.0 in /usr/local/lib/python3.9/dist-packages (from datasets) (0.3.6)\n",
-      "Requirement already satisfied: tqdm>=4.62.1 in /usr/local/lib/python3.9/dist-packages (from datasets) (4.65.0)\n",
-      "Requirement already satisfied: aiohttp in /usr/local/lib/python3.9/dist-packages (from datasets) (3.8.4)\n",
-      "Requirement already satisfied: fsspec[http]>=2021.11.1 in /usr/local/lib/python3.9/dist-packages (from datasets) (2023.5.0)\n",
-      "Requirement already satisfied: responses<0.19 in /usr/local/lib/python3.9/dist-packages (from datasets) (0.18.0)\n",
-      "Requirement already satisfied: pyyaml>=5.1 in /usr/local/lib/python3.9/dist-packages (from datasets) (6.0)\n",
-      "Requirement already satisfied: requests>=2.19.0 in /usr/local/lib/python3.9/dist-packages (from datasets) (2.31.0)\n",
-      "Requirement already satisfied: multiprocess in /usr/local/lib/python3.9/dist-packages (from datasets) (0.70.14)\n",
-      "Requirement already satisfied: numpy>=1.17 in /usr/local/lib/python3.9/dist-packages (from datasets) (1.24.3)\n",
-      "Requirement already satisfied: pandas in /usr/local/lib/python3.9/dist-packages (from datasets) (2.0.1)\n",
-      "Requirement already satisfied: filelock in /usr/local/lib/python3.9/dist-packages (from huggingface_hub) (3.12.0)\n",
-      "Requirement already satisfied: typing-extensions>=3.7.4.3 in /root/.local/lib/python3.9/site-packages (from huggingface_hub) (4.6.2)\n",
-      "Requirement already satisfied: ipykernel>=4.5.1 in /root/.local/lib/python3.9/site-packages (from ipywidgets) (6.23.1)\n",
-      "Requirement already satisfied: widgetsnbextension~=4.0.7 in /usr/local/lib/python3.9/dist-packages (from ipywidgets) (4.0.7)\n",
-      "Requirement already satisfied: traitlets>=4.3.1 in /root/.local/lib/python3.9/site-packages (from ipywidgets) (5.9.0)\n",
-      "Requirement already satisfied: jupyterlab-widgets~=3.0.7 in /usr/local/lib/python3.9/dist-packages (from ipywidgets) (3.0.7)\n",
-      "Requirement already satisfied: ipython>=6.1.0 in /root/.local/lib/python3.9/site-packages (from ipywidgets) (8.13.2)\n",
-      "Requirement already satisfied: frozenlist>=1.1.1 in /usr/local/lib/python3.9/dist-packages (from aiohttp->datasets) (1.3.3)\n",
-      "Requirement already satisfied: attrs>=17.3.0 in /usr/local/lib/python3.9/dist-packages (from aiohttp->datasets) (23.1.0)\n",
-      "Requirement already satisfied: charset-normalizer<4.0,>=2.0 in /usr/local/lib/python3.9/dist-packages (from aiohttp->datasets) (3.1.0)\n",
-      "Requirement already satisfied: yarl<2.0,>=1.0 in /usr/local/lib/python3.9/dist-packages (from aiohttp->datasets) (1.9.2)\n",
-      "Requirement already satisfied: aiosignal>=1.1.2 in /usr/local/lib/python3.9/dist-packages (from aiohttp->datasets) (1.3.1)\n",
-      "Requirement already satisfied: async-timeout<5.0,>=4.0.0a3 in /usr/local/lib/python3.9/dist-packages (from aiohttp->datasets) (4.0.2)\n",
-      "Requirement already satisfied: multidict<7.0,>=4.5 in /usr/local/lib/python3.9/dist-packages (from aiohttp->datasets) (6.0.4)\n",
-      "Requirement already satisfied: psutil in /root/.local/lib/python3.9/site-packages (from ipykernel>=4.5.1->ipywidgets) (5.9.5)\n",
-      "Requirement already satisfied: jupyter-core!=5.0.*,>=4.12 in /root/.local/lib/python3.9/site-packages (from ipykernel>=4.5.1->ipywidgets) (5.3.0)\n",
-      "Requirement already satisfied: jupyter-client>=6.1.12 in /root/.local/lib/python3.9/site-packages (from ipykernel>=4.5.1->ipywidgets) (8.2.0)\n",
-      "Requirement already satisfied: matplotlib-inline>=0.1 in /root/.local/lib/python3.9/site-packages (from ipykernel>=4.5.1->ipywidgets) (0.1.6)\n",
-      "Requirement already satisfied: tornado>=6.1 in /root/.local/lib/python3.9/site-packages (from ipykernel>=4.5.1->ipywidgets) (6.3.2)\n",
-      "Requirement already satisfied: comm>=0.1.1 in /root/.local/lib/python3.9/site-packages (from ipykernel>=4.5.1->ipywidgets) (0.1.3)\n",
-      "Requirement already satisfied: nest-asyncio in /root/.local/lib/python3.9/site-packages (from ipykernel>=4.5.1->ipywidgets) (1.5.6)\n",
-      "Requirement already satisfied: debugpy>=1.6.5 in /root/.local/lib/python3.9/site-packages (from ipykernel>=4.5.1->ipywidgets) (1.6.7)\n",
-      "Requirement already satisfied: pyzmq>=20 in /root/.local/lib/python3.9/site-packages (from ipykernel>=4.5.1->ipywidgets) (25.1.0)\n",
-      "Requirement already satisfied: stack-data in /root/.local/lib/python3.9/site-packages (from ipython>=6.1.0->ipywidgets) (0.6.2)\n",
-      "Requirement already satisfied: backcall in /root/.local/lib/python3.9/site-packages (from ipython>=6.1.0->ipywidgets) (0.2.0)\n",
-      "Requirement already satisfied: prompt-toolkit!=3.0.37,<3.1.0,>=3.0.30 in /root/.local/lib/python3.9/site-packages (from ipython>=6.1.0->ipywidgets) (3.0.38)\n",
-      "Requirement already satisfied: pickleshare in /root/.local/lib/python3.9/site-packages (from ipython>=6.1.0->ipywidgets) (0.7.5)\n",
-      "Requirement already satisfied: pexpect>4.3 in /root/.local/lib/python3.9/site-packages (from ipython>=6.1.0->ipywidgets) (4.8.0)\n",
-      "Requirement already satisfied: jedi>=0.16 in /root/.local/lib/python3.9/site-packages (from ipython>=6.1.0->ipywidgets) (0.18.2)\n",
-      "Requirement already satisfied: pygments>=2.4.0 in /root/.local/lib/python3.9/site-packages (from ipython>=6.1.0->ipywidgets) (2.15.1)\n",
-      "Requirement already satisfied: decorator in /root/.local/lib/python3.9/site-packages (from ipython>=6.1.0->ipywidgets) (5.1.1)\n",
-      "Requirement already satisfied: urllib3<3,>=1.21.1 in /usr/local/lib/python3.9/dist-packages (from requests>=2.19.0->datasets) (2.0.2)\n",
-      "Requirement already satisfied: idna<4,>=2.5 in /usr/local/lib/python3.9/dist-packages (from requests>=2.19.0->datasets) (3.4)\n",
-      "Requirement already satisfied: certifi>=2017.4.17 in /usr/local/lib/python3.9/dist-packages (from requests>=2.19.0->datasets) (2023.5.7)\n",
-      "Requirement already satisfied: tzdata>=2022.1 in /usr/local/lib/python3.9/dist-packages (from pandas->datasets) (2023.3)\n",
-      "Requirement already satisfied: python-dateutil>=2.8.2 in /root/.local/lib/python3.9/site-packages (from pandas->datasets) (2.8.2)\n",
-      "Requirement already satisfied: pytz>=2020.1 in /usr/local/lib/python3.9/dist-packages (from pandas->datasets) (2023.3)\n",
-      "Requirement already satisfied: parso<0.9.0,>=0.8.0 in /root/.local/lib/python3.9/site-packages (from jedi>=0.16->ipython>=6.1.0->ipywidgets) (0.8.3)\n",
-      "Requirement already satisfied: importlib-metadata>=4.8.3 in /root/.local/lib/python3.9/site-packages (from jupyter-client>=6.1.12->ipykernel>=4.5.1->ipywidgets) (6.6.0)\n",
-      "Requirement already satisfied: platformdirs>=2.5 in /root/.local/lib/python3.9/site-packages (from jupyter-core!=5.0.*,>=4.12->ipykernel>=4.5.1->ipywidgets) (3.5.1)\n",
-      "Requirement already satisfied: ptyprocess>=0.5 in /root/.local/lib/python3.9/site-packages (from pexpect>4.3->ipython>=6.1.0->ipywidgets) (0.7.0)\n",
-      "Requirement already satisfied: wcwidth in /root/.local/lib/python3.9/site-packages (from prompt-toolkit!=3.0.37,<3.1.0,>=3.0.30->ipython>=6.1.0->ipywidgets) (0.2.6)\n",
-      "Requirement already satisfied: six>=1.5 in /root/.local/lib/python3.9/site-packages (from python-dateutil>=2.8.2->pandas->datasets) (1.16.0)\n",
-      "Requirement already satisfied: pure-eval in /root/.local/lib/python3.9/site-packages (from stack-data->ipython>=6.1.0->ipywidgets) (0.2.2)\n",
-      "Requirement already satisfied: executing>=1.2.0 in /root/.local/lib/python3.9/site-packages (from stack-data->ipython>=6.1.0->ipywidgets) (1.2.0)\n",
-      "Requirement already satisfied: asttokens>=2.1.0 in /root/.local/lib/python3.9/site-packages (from stack-data->ipython>=6.1.0->ipywidgets) (2.2.1)\n",
-      "Requirement already satisfied: zipp>=0.5 in /root/.local/lib/python3.9/site-packages (from importlib-metadata>=4.8.3->jupyter-client>=6.1.12->ipykernel>=4.5.1->ipywidgets) (3.15.0)\n",
-      "\u001b[33mWARNING: Running pip as the 'root' user can result in broken permissions and conflicting behaviour with the system package manager. It is recommended to use a virtual environment instead: https://pip.pypa.io/warnings/venv\u001b[0m\u001b[33m\n",
-      "\u001b[0m"
-     ]
-    },
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "c5591c50842d4a6f99800ce774776236",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "VBox(children=(HTML(value='<center> <img\\nsrc=https://huggingface.co/front/assets/huggingface_logo-noborder.sv…"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
+   "outputs": [],
    "source": [
     "# install dependencies and get a token\n",
     "!pip install datasets huggingface_hub ipywidgets\n",
@@ -119,160 +33,93 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Update Dataset from Github\n",
-    "Note: this requires write access to the dataset."
+    "# Explore Dataset"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [
     {
-     "name": "stdout",
+     "name": "stderr",
      "output_type": "stream",
      "text": [
-      "--2023-05-29 19:03:22--  https://raw.githubusercontent.com/docugami/DFM-benchmarks/main/data/annotations/CSL-Large.csv\n",
-      "Resolving raw.githubusercontent.com (raw.githubusercontent.com)... 185.199.111.133, 185.199.110.133, 185.199.108.133, ...\n",
-      "Connecting to raw.githubusercontent.com (raw.githubusercontent.com)|185.199.111.133|:443... connected.\n",
-      "HTTP request sent, awaiting response... 200 OK\n",
-      "Length: 1130946 (1.1M) [text/plain]\n",
-      "Saving to: ‘./temp/CSL-Large.csv.1’\n",
-      "\n",
-      "CSL-Large.csv.1     100%[===================>]   1.08M  5.72MB/s    in 0.2s    \n",
-      "\n",
-      "2023-05-29 19:03:23 (5.72 MB/s) - ‘./temp/CSL-Large.csv.1’ saved [1130946/1130946]\n",
-      "\n"
+      "Found cached dataset parquet (/root/.cache/huggingface/datasets/docugami___parquet/docugami--dfm-csl-large-benchmark-1b323996e223b130/0.0.0/2a3b91fbd88a2c90d1dbbb32b460cf621d31bd5b05b934492fdef7d8d6f236ec)\n"
      ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "Dataset({\n",
+       "    features: ['Text', 'Ground Truth', 'docugami/dfm-csl-large'],\n",
+       "    num_rows: 1088\n",
+       "})"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
     }
    ],
    "source": [
-    "# download latest CSV from github\n",
-    "!wget -P ./temp https://raw.githubusercontent.com/docugami/DFM-benchmarks/main/data/annotations/CSL-Large.csv"
+    "from datasets import load_dataset\n",
+    "\n",
+    "# Download and check out metadata for dataset\n",
+    "dataset = load_dataset(\"docugami/dfm-csl-large-benchmark\", split=\"eval\")\n",
+    "dataset"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Downloading and preparing dataset csv/default to /root/.cache/huggingface/datasets/csv/default-386db05c8f0598e0/0.0.0...\n"
-     ]
-    },
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "63298c1dcbd642468f3cc580bcc80297",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "Downloading data files:   0%|          | 0/1 [00:00<?, ?it/s]"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    },
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "4d2d9eec67e64fcba634c69f2453beaf",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "Extracting data files:   0%|          | 0/1 [00:00<?, ?it/s]"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    },
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "69c7b2b3090a488bad506b66496105c4",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "Generating train split: 0 examples [00:00, ? examples/s]"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Dataset csv downloaded and prepared to /root/.cache/huggingface/datasets/csv/default-386db05c8f0598e0/0.0.0. Subsequent calls will reuse this data.\n"
-     ]
-    },
     {
      "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "0c719935d3824027b1caa3260bcbbf1e",
-       "version_major": 2,
-       "version_minor": 0
-      },
       "text/plain": [
-       "Pushing dataset shards to the dataset hub:   0%|          | 0/1 [00:00<?, ?it/s]"
+       "{'Text': \"Tenant, at all times during the term of this Lease and at Tenant's expense, shall provide and keep in force with insurers reasonably approved by Landlord Commercial General Liability insurance against all claims for personal injury, bodily injury, death or property damage occurring upon, in or about the Premises, such insurance (a) to be on an occurrence basis with a general aggregate of not less than\",\n",
+       " 'Ground Truth': 'Commercial General Liability Insurance',\n",
+       " 'docugami/dfm-csl-large': 'Commercial General Liability Insurance'}"
       ]
      },
+     "execution_count": 3,
      "metadata": {},
-     "output_type": "display_data"
-    },
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "fb17ac28c0044959bf19f24a8c33e2a0",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "Creating parquet from Arrow format:   0%|          | 0/2 [00:00<?, ?ba/s]"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    },
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "a0cc1556120a41dfaa6fa36c07cb67c2",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "Upload 1 LFS files:   0%|          | 0/1 [00:00<?, ?it/s]"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    },
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "d24bc578be9347eba62f452e489cb568",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "Downloading metadata:   0%|          | 0.00/21.0 [00:00<?, ?B/s]"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
+     "output_type": "execute_result"
     }
    ],
+   "source": [
+    "# let's look at one of the rows\n",
+    "dataset[-1]"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Update Dataset from Github\n",
+    "Note: this requires write access to the dataset."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# download latest CSV from github\n",
+    "!wget -P ./temp https://raw.githubusercontent.com/docugami/DFM-benchmarks/main/data/annotations/CSL-Large.csv"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
    "source": [
     "from datasets import Dataset\n",
     "\n",
@@ -282,13 +129,6 @@
     "# Push the dataset to the Hugging Face Hub\n",
     "dataset.push_to_hub(DATASET_NAME, split=\"eval\")"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {