export examples

Author: Matt Sokoloff

examples/README.md

@@ -0,0 +1,17 @@
+## Labelbox SDK Examples
+
+##### This section contains examples for using the sdk.
+Ideally we will have examples for all use cases.
+If you need an example to help you with a particular use case please reach out (msokoloff@labelbox.com)
+
+
+Structure:
+
+1. basics
+    * These are all of the required concepts to use the sdk. Other sections build off of this one so make sure you are familiar.
+2. data_export
+    * Contains information on how to export and use labels from labelbox
+3. model_assisted_labeling
+    * Provides examples on using and debugging mal.
+4. project_configuration
+    * Scripts on setting up project. This explains more sophisticatd configurations including customizing the queue.

examples/basics/README.MD

@@ -146,27 +146,36 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
-   "id": "adapted-parish",
+   "execution_count": null,
+   "id": "rational-marshall",
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "<Project ID: ckk4q1viuc0w20704eh69u28h>"
-      ]
-     },
-     "execution_count": 14,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "#The above two queries return PaginatedCollections because the filter parameters aren't guarenteed to be unique.\n",
     "#This object is an iterable containing the query results\n",
     "next(projects)"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "handmade-yugoslavia",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Filtering is only supported using the object you are querying for\n",
+    "#eg. is not valid since get_project returns a Project but we are filtering on a Dataset\n",
+    "projects = client.get_projects(where = Dataset.name == \"dataset_name\") #INVALID\n",
+    "\n",
+    "## Instead we should use relationships.\n",
+    "#If we want all projects where there is a particular attached dataset we can do\n",
+    "list(dataset.project())\n",
+    "#Filtering Takeaways\n",
+    "#1. Filtering only works on a single object type at a time\n",
+    "#2. The where clause requires that we pass an object that is of the same type that is being retured by the query\n",
+    "#3. If we want to filter based on a relationship, we should use the relationship attribute of objects"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 15,

examples/basics/basics.ipynb

@@ -18,19 +18,7 @@
     "    - Those datasets have datarows which is what is being labeled\n",
     "* Each project has an ontology which defines the types of annotations supported during this labeling pass\n",
     "\n",
-    "** Note that there is a lot of advanced usage that is not covered in this notebook. See workflows for those functions.\n",
-    "1. export_labels() #Is in here but much more details can be found in the workflows\n",
-    "2. labeler_performance()\n",
-    "3. review_metrics\n",
-    "4. upload_annotations\n",
-    "5. Setup *** \n",
-    "6. set_labeling_parameter_overrides\n",
-    "7. unset_labeling_parameter_overrides\n",
-    "8. upsert_review_queue\n",
-    "9. enable_model_assisted_labeling\n",
-    "\n",
-    "##TODO: Go through and add references to workflow notebooks for these functions\n",
-    "\n",
+    "** Note that there is a lot of advanced usage that is not covered in this notebook. See project_setup for those functions.\n",
     "* Also note that deprecated functions are not explained here."
    ]
   },