Merge pull request #431 from Labelbox/al-1482

update to notebooks to include example of start and end filters

Author: jtsodapop

examples/label_export/images.ipynb

@@ -41,39 +41,71 @@
             "id": "manual-parks",
             "metadata": {},
             "outputs": [],
-            "source": "!pip install labelbox\n!pip install requests"
+            "source": [
+                "!pip install labelbox\n",
+                "!pip install requests"
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 2,
             "id": "supported-shield",
             "metadata": {},
             "outputs": [],
-            "source": "from labelbox import Client\nfrom getpass import getpass\nimport requests\nfrom collections import Counter\nimport os"
+            "source": [
+                "from labelbox import Client\n",
+                "from getpass import getpass\n",
+                "import requests\n",
+                "from collections import Counter\n",
+                "import os"
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 3,
             "id": "preceding-vitamin",
             "metadata": {},
             "outputs": [],
-            "source": "# If you don't want to give google access to drive you can skip this cell\n# and manually set `API_KEY` below.\n\nCOLAB = \"google.colab\" in str(get_ipython())\nif COLAB:\n    !pip install colab-env -qU\n    from colab_env import envvar_handler\n    envvar_handler.envload()\n\nAPI_KEY = os.environ.get(\"LABELBOX_API_KEY\")\nif not os.environ.get(\"LABELBOX_API_KEY\"):\n    API_KEY = getpass(\"Please enter your labelbox api key\")\n    if COLAB:\n        envvar_handler.add_env(\"LABELBOX_API_KEY\", API_KEY)"
+            "source": [
+                "# If you don't want to give google access to drive you can skip this cell\n",
+                "# and manually set `API_KEY` below.\n",
+                "\n",
+                "COLAB = \"google.colab\" in str(get_ipython())\n",
+                "if COLAB:\n",
+                "    !pip install colab-env -qU\n",
+                "    from colab_env import envvar_handler\n",
+                "    envvar_handler.envload()\n",
+                "\n",
+                "API_KEY = os.environ.get(\"LABELBOX_API_KEY\")\n",
+                "if not os.environ.get(\"LABELBOX_API_KEY\"):\n",
+                "    API_KEY = getpass(\"Please enter your labelbox api key\")\n",
+                "    if COLAB:\n",
+                "        envvar_handler.add_env(\"LABELBOX_API_KEY\", API_KEY)"
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 4,
             "id": "nominated-press",
             "metadata": {},
             "outputs": [],
-            "source": "# Pick a project that has entity tools in the ontology and has completed labels\nPROJECT_ID = \"ckme5v7aykpoj0709ufi5h6i2\"\n# Only update this if you have an on-prem deployment\nENDPOINT = \"https://api.labelbox.com/graphql\""
+            "source": [
+                "# Pick a project that has entity tools in the ontology and has completed labels\n",
+                "PROJECT_ID = \"ckme5v7aykpoj0709ufi5h6i2\"\n",
+                "# Only update this if you have an on-prem deployment\n",
+                "ENDPOINT = \"https://api.labelbox.com/graphql\""
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 5,
             "id": "aerial-general",
             "metadata": {},
             "outputs": [],
-            "source": "client = Client(api_key=API_KEY, endpoint=ENDPOINT)\nproject = client.get_project(PROJECT_ID)"
+            "source": [
+                "client = Client(api_key=API_KEY, endpoint=ENDPOINT)\n",
+                "project = client.get_project(PROJECT_ID)"
+            ]
         },
         {
             "cell_type": "markdown",
@@ -89,7 +121,12 @@
             "id": "gothic-investing",
             "metadata": {},
             "outputs": [],
-            "source": "export_url = project.export_labels()"
+            "source": [
+                "export_url = project.export_labels()\n",
+                "\n",
+                "# labels can also be exported with `start` and `end` filters\n",
+                "# export_url = project.export_labels(start=\"2020-01-01\", end=\"2020-01-02\")"
+            ]
         },
         {
             "cell_type": "code",
@@ -105,15 +142,19 @@
                     ]
                 }
             ],
-            "source": "print(export_url)"
+            "source": [
+                "print(export_url)"
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 8,
             "id": "sustained-retro",
             "metadata": {},
             "outputs": [],
-            "source": "exports = requests.get(export_url).json()"
+            "source": [
+                "exports = requests.get(export_url).json()"
+            ]
         },
         {
             "cell_type": "markdown",
@@ -148,7 +189,10 @@
                     "output_type": "execute_result"
                 }
             ],
-            "source": "# Print first label\nexports[0][\"Label\"][\"objects\"][0]"
+            "source": [
+                "# Print first label\n",
+                "exports[0][\"Label\"][\"objects\"][0]"
+            ]
         },
         {
             "cell_type": "markdown",
@@ -166,15 +210,26 @@
             "id": "crazy-swing",
             "metadata": {},
             "outputs": [],
-            "source": "text = exports[0][\"Labeled Data\"]"
+            "source": [
+                "text = exports[0][\"Labeled Data\"]"
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 11,
             "id": "separated-girlfriend",
             "metadata": {},
             "outputs": [],
-            "source": "people = []\norgs = []\nfor entity in exports[0][\"Label\"][\"objects\"]:\n    location = entity[\"data\"][\"location\"]\n    if entity[\"title\"] == \"person\":\n        people.append(text[location[\"start\"]:location[\"end\"]])\n    elif entity[\"title\"] == \"org\":\n        orgs.append(text[location[\"start\"]:location[\"end\"]])"
+            "source": [
+                "people = []\n",
+                "orgs = []\n",
+                "for entity in exports[0][\"Label\"][\"objects\"]:\n",
+                "    location = entity[\"data\"][\"location\"]\n",
+                "    if entity[\"title\"] == \"person\":\n",
+                "        people.append(text[location[\"start\"]:location[\"end\"]])\n",
+                "    elif entity[\"title\"] == \"org\":\n",
+                "        orgs.append(text[location[\"start\"]:location[\"end\"]])"
+            ]
         },
         {
             "cell_type": "code",
@@ -200,7 +255,9 @@
                     "output_type": "execute_result"
                 }
             ],
-            "source": "Counter(people)"
+            "source": [
+                "Counter(people)"
+            ]
         },
         {
             "cell_type": "code",
@@ -273,15 +330,17 @@
                     "output_type": "execute_result"
                 }
             ],
-            "source": "Counter(orgs)"
+            "source": [
+                "Counter(orgs)"
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 14,
             "id": "abandoned-knight",
             "metadata": {},
             "outputs": [],
-            "source": ""
+            "source": []
         }
     ],
     "metadata": {
@@ -305,4 +364,4 @@
     },
     "nbformat": 4,
     "nbformat_minor": 5
-}
+}