adding subclassifications to ontologies (#1063)

Co-authored-by: rahul sharma <rahulsharma@rahuls-MBP.localdomain>
Co-authored-by: rahul sharma <rahulsharma@rahuls-MBP.hsd1.fl.comcast.net>

Author: 3 people

examples/basics/ontologies.ipynb

@@ -43,7 +43,7 @@
     {
       "metadata": {},
       "source": [
-        "!pip install labelbox"
+        "!pip install labelbox -q"
       ],
       "cell_type": "code",
       "outputs": [],
@@ -71,7 +71,7 @@
       "metadata": {},
       "source": [
         "# Add your api key\n",
-        "API_KEY = None\n",
+        "API_KEY = \"Enter api key here\"\n",
         "client = lb.Client(api_key=API_KEY)"
       ],
       "cell_type": "code",
@@ -212,13 +212,41 @@
     {
       "metadata": {},
       "source": [
-        "### Update and Delete\n",
-        "- At this time, these options are not supported from the SDK.\n",
-        "- Updating an ontology is dangerous and could cause labels to be hidden. \n",
-        "    - Use caution when doing so"
+        "### Update and Delete"
       ],
       "cell_type": "markdown"
     },
+    {
+      "metadata": {},
+      "source": [
+        "# Check if feature is archived\n",
+        "feature_schema = next(client.get_feature_schemas(\"cat\"))\n",
+        "client.is_feature_schema_archived(ontology_id=ontology.uid, feature_schema_id=feature_schema.uid)"
+      ],
+      "cell_type": "code",
+      "outputs": [],
+      "execution_count": null
+    },
+    {
+      "metadata": {},
+      "source": [
+        "Delete or Archived a feature:\n",
+        "\n",
+        "If the feature schema is a root level node with associated labels, it will be archived.\n",
+        "If the feature schema is a nested node in the ontology and does not have associated labels, it will be deleted.\n",
+        "If the feature schema is a nested node in the ontology and has associated labels, it will not be deleted."
+      ],
+      "cell_type": "markdown"
+    },
+    {
+      "metadata": {},
+      "source": [
+        "client.delete_feature_schema_from_ontology(ontology_id=ontology.uid, feature_schema_id=feature_schema.uid)"
+      ],
+      "cell_type": "code",
+      "outputs": [],
+      "execution_count": null
+    },
     {
       "metadata": {},
       "source": [
@@ -286,12 +314,12 @@
         "             name=\"cat\",\n",
         "             classifications=[\n",
         "                 lb.Classification(class_type=lb.Classification.Type.TEXT,\n",
-        "                                instructions=\"name\")\n",
+        "                                name=\"name\")\n",
         "             ])\n",
         "    ],\n",
         "    classifications=[\n",
         "        lb.Classification(class_type=lb.Classification.Type.RADIO,\n",
-        "                       instructions=\"image_quality\",\n",
+        "                       name=\"image_quality\",\n",
         "                       options=[lb.Option(value=\"clear\"),\n",
         "                                lb.Option(value=\"blurry\")])\n",
         "    ])\n",
@@ -301,6 +329,35 @@
       "outputs": [],
       "execution_count": null
     },
+    {
+      "metadata": {},
+      "source": [
+        "Example of how to add sub-classfication within an option"
+      ],
+      "cell_type": "markdown"
+    },
+    {
+      "metadata": {},
+      "source": [
+        "# We will use add_classification to add this classification to a previously built ontology_builder or you can create new ontology_builder = OntologyBuilder() \n",
+        "radio_classification = lb.Classification(class_type=lb.Classification.Type.RADIO,\n",
+        "                                      name=\"Global classification\",\n",
+        "                                      options=[lb.Option(\"1st option\", options=[lb.Classification(class_type=lb.Classification.Type.CHECKLIST,\n",
+        "                                                                                            name=\"Inside 1st option\",\n",
+        "                                                                                            options=[lb.Option(\"Option A\"), lb.Option(\"Option B\")])]), lb.Option(\"2nd option\", options=[lb.Classification(class_type=lb.Classification.Type.CHECKLIST,\n",
+        "                                                                                                                                                                                              name=\"Inside 2nd option\",\n",
+        "                                                                                                                                                                                              options=[lb.Option(\"Option A\"), lb.Option(\"Option B\")])])])\n",
+        "\n",
+        "ontology_builder.add_classification(radio_classification)                                                                                                                                                                                         \n",
+        "\n",
+        "ontology = client.create_ontology(\"example of nested classification\",\n",
+        "                                  ontology_builder.asdict())\n",
+        "print(json.dumps(ontology.normalized, indent=2))"
+      ],
+      "cell_type": "code",
+      "outputs": [],
+      "execution_count": null
+    },
     {
       "metadata": {},
       "source": [
@@ -335,13 +392,13 @@
       "metadata": {},
       "source": [
         "text_classification = lb.Classification(class_type=lb.Classification.Type.TEXT,\n",
-        "                                     instructions=\"dog_name\")\n",
+        "                                     name=\"dog_name\")\n",
         "radio_classification = lb.Classification(class_type=lb.Classification.Type.RADIO,\n",
-        "                                      instructions=\"dog_breed\",\n",
+        "                                      name=\"dog_breed\",\n",
         "                                      options=[lb.Option(\"poodle\")])\n",
         "checklist_classification = lb.Classification(\n",
         "    class_type=lb.Classification.Type.CHECKLIST,\n",
-        "    instructions=\"background\",\n",
+        "    name=\"background\",\n",
         "    options=[lb.Option(\"at_park\"), lb.Option(\"has_leash\")])"
       ],
       "cell_type": "code",