Merge pull request #340 from Labelbox/ms/ontology-updates

ontology management

Author: msokoloff1

examples/basics/ontologies.ipynb

@@ -6,7 +6,7 @@
    "metadata": {},
    "source": [
     "# Project Setup\n",
-    "* This section describes how to create and configure a project\n",
+    "* This notebok describes how to create and configure a project\n",
     "* This is the same as creating a new project in the editor and going through all of the steps."
    ]
   },
@@ -22,7 +22,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "id": "contemporary-banking",
    "metadata": {},
    "outputs": [],
@@ -32,60 +32,24 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "id": "ordered-notice",
    "metadata": {},
    "outputs": [],
    "source": [
-    "from labelbox import Client, Project, LabelingFrontend\n",
-    "from labelbox.schema.ontology import Tool, OntologyBuilder\n",
-    "from getpass import getpass\n",
-    "import os"
+    "from labelbox import Client, Project, Tool, OntologyBuilder"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
-   "id": "alert-train",
-   "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)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": null,
    "id": "royal-algeria",
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Set this to a project that is already set up\n",
-    "PROJECT_ID = \"ckm4xyfncfgja0760vpfdxoro\"\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": "welsh-maker",
-   "metadata": {},
-   "outputs": [],
-   "source": [
+    "# Add your api key\n",
+    "API_KEY = None\n",
+    "ENDPOINT = \"https://api.labelbox.com/graphql\"\n",
     "client = Client(api_key=API_KEY, endpoint=ENDPOINT)"
    ]
   },
@@ -94,86 +58,71 @@
    "id": "least-stone",
    "metadata": {},
    "source": [
-    "### Identify project, dataset, and ontology\n",
-    "* Pick the project to setup\n",
-    "* Dataset(s) to attach to that project\n",
-    "* Configure the ontology for the project"
+    "### Create Dataset\n",
+    "* Create dataset and attach data\n",
+    "* More details on attaching data can be found [here](https://github.com/Labelbox/labelbox-python/blob/develop/examples/basics/data_rows.ipynb)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
-   "id": "mobile-south",
+   "execution_count": null,
+   "id": "0c195add",
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Use bounding boxes to label cats\n",
-    "ontology_builder = OntologyBuilder(\n",
-    "    tools=[Tool(name=\"cat\", tool=Tool.Type.BBOX)])\n",
-    "project = client.create_project(name=\"my_new_project\")\n",
     "dataset = client.create_dataset(name=\"my_new_dataset\")\n",
     "# Add data_rows since this is a new dataset (see basics/data_rows.ipynb for more information on this)\n",
     "test_img_url = \"https://raw.githubusercontent.com/Labelbox/labelbox-python/develop/examples/assets/2560px-Kitano_Street_Kobe01s5s4110.jpg\"\n",
     "dataset.create_data_row(row_data=test_img_url)"
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "neural-scanning",
+   "cell_type": "markdown",
+   "id": "e4f8b7f7",
    "metadata": {},
-   "outputs": [],
    "source": [
-    "# Unless you are using a custom editor you should always use the following editor:\n",
-    "editor = next(\n",
-    "    client.get_labeling_frontends(where=LabelingFrontend.name == \"Editor\"))"
+    "### Create Or Select an Ontology\n",
+    "* Optionally create an ontology or select from an existing one.\n",
+    "* More details on ontology management can be found [here](https://github.com/Labelbox/labelbox-python/blob/develop/examples/basics/ontologies.ipynb)\n",
+    "   "
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
-   "id": "attended-twist",
+   "execution_count": null,
+   "id": "a9e4738c",
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Note that you can use any dataset or ontology even if they already exist.\n",
-    "existing_project = client.get_project(PROJECT_ID)\n",
-    "# We are not using this, but it is possible to copy the ontology to the new project\n",
-    "ontology = existing_project.ontology()"
+    "# Create\n",
+    "ontology_builder = OntologyBuilder(\n",
+    "    tools=[Tool(name=\"cat\", tool=Tool.Type.BBOX)])\n",
+    "ontology = client.create_ontology(\"project-setup-demo-ontology\", ontology_builder.asdict())\n",
+    "# Select existing ontology\n",
+    "#ontology = client.get_ontology(\"<ontology_id>\")\n",
+    "#ontology = existing_project.ontology()\n"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "limiting-bleeding",
    "metadata": {},
    "source": [
-    "### Setup and attach dataset\n",
+    "### Create Project and Setup the Editor\n",
     "* Setting up a project will add an ontology and will enable labeling to begin\n",
     "* Attaching dataset(s) will add all data_rows belonging to the dataset to the queue."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": null,
    "id": "reserved-vietnam",
    "metadata": {},
    "outputs": [],
    "source": [
-    "project.setup(editor, ontology_builder.asdict())\n",
-    "# Could also do if ontology is a normalized ontology\n",
-    "# project.setup(editor, ontology.normalized)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "unexpected-vegetarian",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Run this for each dataset we want to attach\n",
-    "project.datasets.connect(dataset)\n",
-    "# project.datasets.connect(another_dataset)"
+    "project = client.create_project(name=\"my_new_project\")\n",
+    "project.setup_editor(ontology)\n",
+    "project.datasets.connect(dataset)"
    ]
   },
   {
@@ -186,41 +135,39 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": null,
    "id": "vanilla-diamond",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "2021-03-17 12:35:00+00:00\n",
-      "<labelbox.orm.db_object.RelationshipManager object at 0x1046030d0>\n",
-      "['my_new_dataset']\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "# Note setup_complete will be None if it fails.\n",
     "print(project.setup_complete)\n",
-    "print(project.ontology)\n",
+    "print(project.ontology())\n",
     "print([ds.name for ds in project.datasets()])"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": null,
    "id": "alpha-dayton",
    "metadata": {},
    "outputs": [],
    "source": [
     "print(f\"https://app.labelbox.com/projects/{project.uid}\")"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "dec2f4c9",
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -234,7 +181,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.8.2"
   }
  },
  "nbformat": 4,