Merge pull request #921 from Labelbox/lgluszek/PTDT-1115

[PTDT-1115] User can create a relationship feature

Author: lgluszek

examples/annotation_import/image.ipynb

@@ -626,7 +626,10 @@
         "      name=\"point\"), \n",
         "    lb.Tool( # Polyline tool given the name \"line\"\n",
         "      tool=lb.Tool.Type.LINE,\n",
-        "      name=\"polyline\")]\n",
+        "      name=\"polyline\"),\n",
+        "    lb.Tool( # Relationship tool given the name \"relationship\"\n",
+        "      tool=lb.Tool.Type.RELATIONSHIP,\n",
+        "      name=\"relationship\")]\n",
         ")\n",
         "\n",
         "ontology = client.create_ontology(\"Image Prediction Import Demo\", ontology_builder.asdict(), media_type=lb.MediaType.Image)"

examples/annotation_import/pdf.ipynb

@@ -120,12 +120,14 @@
     {
       "metadata": {},
       "source": [
-        "tool_name = \"super\"\n",
         "ontology_builder = lb.OntologyBuilder(\n",
         "  tools=[ \n",
         "    lb.Tool( # Entity tool given the name \"NER\"\n",
         "      tool=lb.Tool.Type.NER, \n",
-        "      name= tool_name)]\n",
+        "      name= \"NER\"),\n",
+        "    lb.Tool( # Relationship tool given the name \"relationship\"\n",
+        "      tool=lb.Tool.Type.RELATIONSHIP, \n",
+        "      name=\"relationship\")]\n",
         "    )"
       ],
       "cell_type": "code",

examples/basics/ontologies.ipynb

@@ -93,7 +93,8 @@
         "| Polyline          | line         |\n",
         "| Point             | point        |\n",
         "| Segmentation mask | superpixel   |\n",
-        "| Entity            | named-entity |"
+        "| Entity            | named-entity |\n",
+        "| Relationship      | edge         |"
       ],
       "cell_type": "markdown"
     },
@@ -315,7 +316,8 @@
         "seg_tool = lb.Tool(tool=lb.Tool.Type.SEGMENTATION, name=\"dog_seg\")\n",
         "point_tool = lb.Tool(tool=lb.Tool.Type.POINT, name=\"dog_center\")\n",
         "line_tool = lb.Tool(tool=lb.Tool.Type.LINE, name=\"dog_orientation\")\n",
-        "ner_tool = lb.Tool(tool=lb.Tool.Type.NER, name=\"dog_reference\")"
+        "ner_tool = lb.Tool(tool=lb.Tool.Type.NER, name=\"dog_reference\")\n",
+        "relationship_tool = lb.Tool(tool=lb.Tool.Type.RELATIONSHIP, name=\"relationship\")"
       ],
       "cell_type": "code",
       "outputs": [],

examples/prediction_upload/video_predictions.ipynb

@@ -583,7 +583,10 @@
         "      name=\"point_video\"), \n",
         "    lb.Tool( # Polyline tool given the name \"line\"\n",
         "      tool=lb.Tool.Type.LINE,\n",
-        "      name=\"line_video_frame\")]\n",
+        "      name=\"line_video_frame\"),\n",
+        "    lb.Tool( # Relationship tool given the name \"relationship\"\n",
+        "      tool=lb.Tool.Type.RELATIONSHIP,\n",
+        "      name=\"relationship_video\")]\n",
         ")\n",
         "\n",
         "ontology = client.create_ontology(\"Video Prediction Import Demo\", ontology_builder.asdict(), media_type=lb.MediaType.Video)\n",

labelbox/schema/ontology.py

@@ -241,6 +241,7 @@ class Type(Enum):
         BBOX = "rectangle"
         LINE = "line"
         NER = "named-entity"
+        RELATIONSHIP = "edge"
 
     tool: Type
     name: str