Update examples

Author: stuartquin

README.md

@@ -2,7 +2,7 @@
 
 ![Build Status](https://github.com/dataqa/jupyter-annotate/actions/workflows/build.yml/badge.svg?branch=main)
 
-Inline Text Annotation for Jupyter Notebook/Lab
+Interactive Text Annotation for Jupyter Notebook/Lab
 
 ![Jupyter Annotate](examples/images/Annotate_1.png?raw=true "Jupyter Annotate")
 
@@ -23,6 +23,8 @@ jupyter nbextension enable --py [--sys-prefix|--user|--system] jupyterannotate
 
 ## Usage
 
+See [Example](examples/introduction.ipynb)
+
 Within an Jupyter Notebook cell:
 
 ```
@@ -36,9 +38,16 @@ DOCUMENTS = [
 ]
 
 # Instantiate widget
+# Optionally specify a list of spans to prepopulate
 annotation_widget = jupyterannotate.AnnotateWidget(
     docs=NEWS_HEADLINES,
-    labels=LABELS
+    labels=LABELS,
+    spans=[
+      [
+        {'start': 0, 'end': 6, 'text': 'Oracle', 'label': 'Organization'},
+      ],
+      []
+    ]
 )
 
 # Render
@@ -56,8 +65,20 @@ annotation_widget
 # Access spans - a List containing a List of Spans per document
 # e.g. [[{'start': 0, 'end': 6, 'text': 'Oracle', 'label': 'Organization'}], []]
 annotation_widget.spans
+
+
+# See updates in real-time
+annotation_widget.spans = [
+    [
+        {'start': 0, 'end': 6, 'text': 'Oracle', 'label': 'Organization'},
+        {'start': 69, 'end': 72, 'text': '10g', 'label': 'Quantity'}
+    ],
+    []
+]
 ```
 
+![Update Python](examples/images/Annotate_2.gif?raw=true "Update Python")
+
 ## Development Installation
 
 Create a dev environment:

examples/images/Annotate_2.gif

@@ -30,7 +30,6 @@
     "NEWS_HEADLINES = [\n",
     "    \"Oracle introduced a new BI platform yesterday, Business Intelligence 10g that rolls up into one solution all of their BI tools. However, more interesting than the nitty-gritty details of what is included is the back story taking place at the same time.\",\n",
     "    \"Microsoft will delay the release of its SP2 update for another week to fix software glitches. But not everyone is quite so eager to install the SP2 update for Windows XP. In fact, many companies have demanded the ability to prevent their ...\",\n",
-    "    \"SAN JOSE, Calif. - In a sign that Google Inc.'s initial public offering isn't as popular as expected, the company lowered its estimated price range to between \\$85 and \\$95 per share, down from the earlier prediction of \\$108 and \\$135 per share...\",\n",
     "]"
    ]
   },
@@ -43,7 +42,7 @@
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "2efc9029e27c4548ab03763df8ab9217",
+       "model_id": "8d5464a00cae4edc9dc697aee834e684",
        "version_major": 2,
        "version_minor": 0
       },
@@ -56,45 +55,36 @@
     }
    ],
    "source": [
+    "# Instantiate widget\n",
     "annotation_widget = jupyterannotate.AnnotateWidget(\n",
     "    docs=NEWS_HEADLINES,\n",
-    "    labels=LABELS\n",
+    "    labels=LABELS,\n",
+    "    spans=[\n",
+    "      [\n",
+    "        {'start': 0, 'end': 6, 'text': 'Oracle', 'label': 'Organization'},\n",
+    "      ],\n",
+    "      []\n",
+    "    ]  \n",
     ")\n",
+    "\n",
     "annotation_widget"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 4,
    "id": "926883f8-328f-4c2f-b7e7-99999c9cc6b1",
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[[{'start': 0, 'end': 6, 'text': 'Oracle', 'label': 'Organization'},\n",
-       "  {'start': 69, 'end': 72, 'text': '10g', 'label': 'Quantity'}],\n",
-       " [{'start': 0, 'end': 9, 'text': 'Microsoft', 'label': 'Organization'},\n",
-       "  {'start': 159, 'end': 169, 'text': 'Windows XP', 'label': 'Product'}],\n",
-       " [{'start': 34, 'end': 40, 'text': 'Google', 'label': 'Organization'}]]"
-      ]
-     },
-     "execution_count": 5,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
-    "annotation_widget.spans"
+    "annotation_widget.spans = [\n",
+    "    [\n",
+    "        {'start': 0, 'end': 6, 'text': 'Oracle', 'label': 'Organization'},\n",
+    "        {'start': 69, 'end': 72, 'text': '10g', 'label': 'Quantity'}\n",
+    "    ],\n",
+    "    []\n",
+    "]"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "b89e2cc0-9ce5-43ff-a4f6-e1908a9e181f",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {

examples/Example.ipynb examples/introduction.ipynb

@@ -4,17 +4,22 @@
 # Copyright (c) Stuart Quin.
 # Distributed under the terms of the Modified BSD License.
 
-"""
-TODO: Add module docstring
-"""
-
 from ipywidgets import DOMWidget, ValueWidget
 from traitlets import Unicode, List
 from ._frontend import module_name, module_version
 
 
 class AnnotateWidget(DOMWidget, ValueWidget):
-    """TODO: Add docstring here"""
+    """Interactive text annotation widget for Jupyter
+
+    Keyword arguments:
+    docs -- List of string documents (required)
+    labels -- List of labels (default [])
+    spans -- List of Lists containing span dicts, (default [])
+
+    span dict format:
+    {'start': 2, 'end': 7, 'text': 'Hello', 'label': 'Test'},
+    """
 
     _model_name = Unicode("AnnotateModel").tag(sync=True)
     _model_module = Unicode(module_name).tag(sync=True)
@@ -25,4 +30,4 @@ class AnnotateWidget(DOMWidget, ValueWidget):
 
     docs = List(trait=Unicode()).tag(sync=True)
     spans = List([]).tag(sync=True)
-    labels = List().tag(sync=True)
+    labels = List([]).tag(sync=True)