Skip to content

Commit 4c8a14f

Browse files
committed
added quick_start notebook
1 parent ca83c51 commit 4c8a14f

File tree

2 files changed

+79
-1
lines changed

2 files changed

+79
-1
lines changed

examples/basics/quick_start.ipynb

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# Quick Start\n",
8+
"\n",
9+
"This notebook is intended to be a quick overview on Labelbox-Python SDK by demonstrating a simple but common work flow\n",
10+
"\n",
11+
"In this guide, we will be:\n",
12+
"\n",
13+
"1. Creating a dataset:\n",
14+
" A dataset is a collection of data rows imported into Labelbox.\n",
15+
"2. Importing an image data row\n",
16+
"3. Creating an ontology\n",
17+
"4. Creating an project and attaching an ontology\n",
18+
"5. Sending our data row towards are project by creating a batch\n",
19+
"6. Exporting from our project\n",
20+
"\n",
21+
"This notebook is geared towards new users of our SDK."
22+
]
23+
},
24+
{
25+
"cell_type": "markdown",
26+
"metadata": {},
27+
"source": [
28+
"## Setup\n",
29+
"\n",
30+
"To start, we first need to install the labelbox library and then import the SDK module. It is recommended to install \"labelbox[data]\" over labelbox to obtain all the correct dependencies. We will also be importing the python UUID library to generate unique IDs for the variety of objects that will be created with this notebook."
31+
]
32+
},
33+
{
34+
"cell_type": "code",
35+
"execution_count": null,
36+
"metadata": {},
37+
"outputs": [],
38+
"source": [
39+
"%pip install -q \"labelbox[data]\""
40+
]
41+
},
42+
{
43+
"cell_type": "code",
44+
"execution_count": null,
45+
"metadata": {},
46+
"outputs": [],
47+
"source": [
48+
"import labelbox as lb\n",
49+
"import uuid"
50+
]
51+
},
52+
{
53+
"cell_type": "markdown",
54+
"metadata": {},
55+
"source": [
56+
"## API Key and Client\n",
57+
"Provide a valid API key below to connect to the Labelbox client properly. For more information, please review the [Create API Key](https://docs.labelbox.com/reference/create-api-key) guide."
58+
]
59+
},
60+
{
61+
"cell_type": "code",
62+
"execution_count": null,
63+
"metadata": {},
64+
"outputs": [],
65+
"source": [
66+
"API_KEY = None\n",
67+
"client = lb.Client(api_key=API_KEY)"
68+
]
69+
}
70+
],
71+
"metadata": {
72+
"language_info": {
73+
"name": "python"
74+
}
75+
},
76+
"nbformat": 4,
77+
"nbformat_minor": 2
78+
}

examples/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ dev-dependencies = [
2323
"black[jupyter]>=24.4.2",
2424
"databooks>=1.3.10",
2525
# higher versions dont support python 3.8
26-
"pandas>=1.5.3",
26+
"pandas>=2.0.3",
2727
]
2828

2929
[tool.rye.scripts]

0 commit comments

Comments
 (0)