Merge pull request #411 from Labelbox/gj/add-headers

Add a header linking to Labelbox, GitHub and Colab

Author: Gareth

examples/annotation_types/basics.ipynb

@@ -1,5 +1,31 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "db768cda",
+   "metadata": {},
+   "source": [
+    "<td>\n",
+    "   <a target=\"_blank\" href=\"https://labelbox.com\" ><img src=\"https://labelbox.com/blog/content/images/2021/02/logo-v4.svg\" width=256/></a>\n",
+    "</td>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "cb5611d0",
+   "metadata": {},
+   "source": [
+    "<td>\n",
+    "<a href=\"https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/basics/data_rows.ipynb\" target=\"_blank\"><img\n",
+    "src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"></a>\n",
+    "</td>\n",
+    "\n",
+    "<td>\n",
+    "<a href=\"https://github.com/Labelbox/labelbox-python/tree/develop/examples/basics/data_rows.ipynb\" target=\"_blank\"><img\n",
+    "src=\"https://img.shields.io/badge/GitHub-100000?logo=github&logoColor=white\" alt=\"GitHub\"></a>\n",
+    "</td>"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -22,46 +48,24 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "!pip install labelbox"
-   ]
+   "source": "!pip install labelbox"
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "from labelbox import DataRow, Client\n",
-    "from getpass import getpass\n",
-    "import uuid\n",
-    "import os"
-   ]
+   "source": "from labelbox import DataRow, Client\nfrom getpass import getpass\nimport uuid\nimport os"
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "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",
-    "\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)"
-   ]
+   "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)"
   },
   {
    "cell_type": "markdown",
@@ -72,37 +76,24 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "# Pick a project that has a dataset attached, data has external ids, and there are some labels\n",
-    "# This will modify the project so just pick a dummy one that you don't care about\n",
-    "PROJECT_ID = \"ckpnfquwy0kyg0y8t9rwb99cz\"\n",
-    "# Only update this if you have an on-prem deployment\n",
-    "ENDPOINT = \"https://api.labelbox.com/graphql\""
-   ]
+   "source": "# Pick a project that has a dataset attached, data has external ids, and there are some labels\n# This will modify the project so just pick a dummy one that you don't care about\nPROJECT_ID = \"ckpnfquwy0kyg0y8t9rwb99cz\"\n# Only update this if you have an on-prem deployment\nENDPOINT = \"https://api.labelbox.com/graphql\""
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "client = Client(api_key=API_KEY, endpoint=ENDPOINT)"
-   ]
+   "source": "client = Client(api_key=API_KEY, endpoint=ENDPOINT)"
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "project = client.get_project(PROJECT_ID)\n",
-    "dataset = next(project.datasets())\n",
-    "# This is the same as\n",
-    "# -> dataset = client.get_dataset(dataset_id)"
-   ]
+   "source": "project = client.get_project(PROJECT_ID)\ndataset = next(project.datasets())\n# This is the same as\n# -> dataset = client.get_dataset(dataset_id)"
   },
   {
    "cell_type": "markdown",
@@ -113,17 +104,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 7,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "data_rows = dataset.data_rows()\n",
-    "data_row = next(data_rows)"
-   ]
+   "source": "data_rows = dataset.data_rows()\ndata_row = next(data_rows)"
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 8,
    "metadata": {},
    "outputs": [
     {
@@ -136,16 +124,11 @@
      ]
     }
    ],
-   "source": [
-    "# Url\n",
-    "print(\"Associated dataset\", data_row.dataset())\n",
-    "print(\"Associated label(s)\", next(data_row.labels()))\n",
-    "print(\"External id\", data_row.external_id)"
-   ]
+   "source": "# Url\nprint(\"Associated dataset\", data_row.dataset())\nprint(\"Associated label(s)\", next(data_row.labels()))\nprint(\"External id\", data_row.external_id)"
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 9,
    "metadata": {},
    "outputs": [
     {
@@ -156,11 +139,7 @@
      ]
     }
    ],
-   "source": [
-    "# External ids can be a reference to your internal datasets\n",
-    "data_row = dataset.data_row_for_external_id(data_row.external_id)\n",
-    "print(data_row)"
-   ]
+   "source": "# External ids can be a reference to your internal datasets\ndata_row = dataset.data_row_for_external_id(data_row.external_id)\nprint(data_row)"
   },
   {
    "cell_type": "markdown",
@@ -172,7 +151,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 10,
    "metadata": {},
    "outputs": [
     {
@@ -186,15 +165,7 @@
      "output_type": "execute_result"
     }
    ],
-   "source": [
-    "dataset = client.create_dataset(name=\"testing-dataset\")\n",
-    "dataset.create_data_row(row_data=\"https://picsum.photos/200/300\")\n",
-    "\n",
-    "# It is reccomended that you use external ids but optional.\n",
-    "# These are useful for users to maintain references to a data_row.\n",
-    "dataset.create_data_row(row_data=\"https://picsum.photos/200/300\",\n",
-    "                        external_id=str(uuid.uuid4()))"
-   ]
+   "source": "dataset = client.create_dataset(name=\"testing-dataset\")\ndataset.create_data_row(row_data=\"https://picsum.photos/200/300\")\n\n# It is reccomended that you use external ids but optional.\n# These are useful for users to maintain references to a data_row.\ndataset.create_data_row(row_data=\"https://picsum.photos/200/300\",\n                        external_id=str(uuid.uuid4()))"
   },
   {
    "cell_type": "markdown",
@@ -205,61 +176,35 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 11,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "task1 = dataset.create_data_rows([{\n",
-    "    DataRow.row_data: \"https://picsum.photos/200/300\"\n",
-    "}, {\n",
-    "    DataRow.row_data: \"https://picsum.photos/200/300\"\n",
-    "}])"
-   ]
+   "source": "task1 = dataset.create_data_rows([{\n    DataRow.row_data: \"https://picsum.photos/200/300\"\n}, {\n    DataRow.row_data: \"https://picsum.photos/200/300\"\n}])"
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 12,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "# Local paths\n",
-    "local_data_path = '/tmp/test_data_row.txt'\n",
-    "with open(local_data_path, 'w') as file:\n",
-    "    file.write(\"sample data\")\n",
-    "\n",
-    "task2 = dataset.create_data_rows([local_data_path])"
-   ]
+   "source": "# Local paths\nlocal_data_path = '/tmp/test_data_row.txt'\nwith open(local_data_path, 'w') as file:\n    file.write(\"sample data\")\n\ntask2 = dataset.create_data_rows([local_data_path])"
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 13,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "# You can mix local files with urls\n",
-    "task3 = dataset.create_data_rows([{\n",
-    "    DataRow.row_data: \"https://picsum.photos/200/300\"\n",
-    "}, local_data_path])"
-   ]
+   "source": "# You can mix local files with urls\ntask3 = dataset.create_data_rows([{\n    DataRow.row_data: \"https://picsum.photos/200/300\"\n}, local_data_path])"
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 14,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "# Note that you cannot set external_ids at this time when uploading from local files.\n",
-    "# To do this you have to first\n",
-    "item_url = client.upload_file(local_data_path)\n",
-    "task4 = dataset.create_data_rows([{\n",
-    "    DataRow.row_data: item_url,\n",
-    "    DataRow.external_id: str(uuid.uuid4())\n",
-    "}])"
-   ]
+   "source": "# Note that you cannot set external_ids at this time when uploading from local files.\n# To do this you have to first\nitem_url = client.upload_file(local_data_path)\ntask4 = dataset.create_data_rows([{\n    DataRow.row_data: item_url,\n    DataRow.external_id: str(uuid.uuid4())\n}])"
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 15,
    "metadata": {},
    "outputs": [
     {
@@ -270,15 +215,7 @@
      ]
     }
    ],
-   "source": [
-    "# Blocking wait until complete\n",
-    "task1.wait_till_done()\n",
-    "task2.wait_till_done()\n",
-    "task3.wait_till_done()\n",
-    "task4.wait_till_done()\n",
-    "\n",
-    "print(task1.status, task2.status, task3.status, task4.status)"
-   ]
+   "source": "# Blocking wait until complete\ntask1.wait_till_done()\ntask2.wait_till_done()\ntask3.wait_till_done()\ntask4.wait_till_done()\n\nprint(task1.status, task2.status, task3.status, task4.status)"
   },
   {
    "cell_type": "markdown",
@@ -289,7 +226,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 16,
    "metadata": {},
    "outputs": [
     {
@@ -300,16 +237,11 @@
      ]
     }
    ],
-   "source": [
-    "# Useful for resigning urls\n",
-    "new_id = str(uuid.uuid4())\n",
-    "data_row.update(external_id=new_id)\n",
-    "print(data_row.external_id, new_id)"
-   ]
+   "source": "# Useful for resigning urls\nnew_id = str(uuid.uuid4())\ndata_row.update(external_id=new_id)\nprint(data_row.external_id, new_id)"
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": 17,
    "metadata": {},
    "outputs": [
     {
@@ -323,14 +255,7 @@
      "output_type": "execute_result"
     }
    ],
-   "source": [
-    "# We can also create attachments\n",
-    "# Attachments are visible for all projects connected to the data_row \n",
-    "data_row.create_attachment(attachment_type=\"TEXT\", attachment_value=\"LABELERS WILL SEE THIS \")\n",
-    "# See more information here:\n",
-    "# https://docs.labelbox.com/reference/type-image\n",
-    "# Note that attachment_value must always be a string (url to a video/image or a text value to display)"
-   ]
+   "source": "# We can also create attachments\n# Attachments are visible for all projects connected to the data_row\ndata_row.create_attachment(attachment_type=\"TEXT\",\n                           attachment_value=\"LABELERS WILL SEE THIS \")\n# See more information here:\n# https://docs.labelbox.com/reference/type-image\n# Note that attachment_value must always be a string (url to a video/image or a text value to display)"
   },
   {
    "cell_type": "markdown",
@@ -341,23 +266,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 17,
+   "execution_count": 18,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "data_row.delete()\n",
-    "# Will remove from the dataset too"
-   ]
+   "source": "data_row.delete()\n# Will remove from the dataset too"
   },
   {
    "cell_type": "code",
-   "execution_count": 18,
+   "execution_count": 19,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "# Bulk delete a list of data_rows (in this case all of them we just uploaded)\n",
-    "DataRow.bulk_delete(list(dataset.data_rows()))"
-   ]
+   "source": "# Bulk delete a list of data_rows (in this case all of them we just uploaded)\nDataRow.bulk_delete(list(dataset.data_rows()))"
   }
  ],
  "metadata": {
@@ -381,4 +300,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}