Skip to content

Cleaned up composite mask information #1671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

Cleaned up composite mask information #1671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3aded85
updated batches
Gabefire Jun 11, 2024
f6769d7
modified task export to remove json.loads
Gabefire Jun 11, 2024
16c2f32
Merge branch 'develop' into gu/major_fixes
Gabefire Jun 11, 2024
bfc4332
removed metadata
Gabefire Jun 11, 2024
2977be0
Merge branch 'gu/major_fixes' of github.com:Labelbox/labelbox-python …
Gabefire Jun 11, 2024
a5220cf
started notebook
Gabefire Jun 12, 2024
8af292c
removed depercation info cleaned composite notebook up slightly
Gabefire Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/annotation_import/pdf.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@
},
{
"metadata": {},
"source": "client.enable_experimental = True\ntask = lb.DataRow.export(client=client, global_keys=[global_key])\ntask.wait_till_done()\nstream = task.get_buffered_stream()\n\ntext_layer = \"\"\nfor output in stream:\n output_json = json.loads(output.json)\n text_layer = output_json[\"media_attributes\"][\"text_layer_url\"]\nprint(text_layer)",
"source": "client.enable_experimental = True\ntask = lb.DataRow.export(client=client, global_keys=[global_key])\ntask.wait_till_done()\nstream = task.get_buffered_stream()\n\ntext_layer = \"\"\nfor output in stream:\n output_json = output.json\n text_layer = output_json[\"media_attributes\"][\"text_layer_url\"]\nprint(text_layer)",
"cell_type": "code",
"outputs": [],
"execution_count": null
Expand Down
215 changes: 152 additions & 63 deletions examples/basics/basics.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
{
"nbformat": 4,
"nbformat_minor": 5,
"metadata": {},
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<td>",
" <a target=\"_blank\" href=\"https://labelbox.com\" ><img src=\"https://labelbox.com/blog/content/images/2021/02/logo-v4.svg\" width=256/></a>",
"<td>\n",
" <a target=\"_blank\" href=\"https://labelbox.com\" ><img src=\"https://labelbox.com/blog/content/images/2021/02/logo-v4.svg\" width=256/></a>\n",
"</td>\n"
],
"cell_type": "markdown"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<td>\n",
Expand All @@ -24,162 +22,253 @@
"<a href=\"https://github.com/Labelbox/labelbox-python/tree/develop/examples/basics/basics.ipynb\" target=\"_blank\"><img\n",
"src=\"https://img.shields.io/badge/GitHub-100000?logo=github&logoColor=white\" alt=\"GitHub\"></a>\n",
"</td>"
],
"cell_type": "markdown"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Basic project/datasets overview\n",
"\n",
"This notebook is used to go over the basic of the Python SDK, such as what a db object is, and how to interact with it. \n",
"\n"
],
"cell_type": "markdown"
]
},
{
"metadata": {},
"source": "%pip install \"labelbox[data]\"",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"%pip install \"labelbox[data]\""
]
},
{
"metadata": {},
"source": "import labelbox as lb",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"import labelbox as lb"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## API key and client\n",
"Provide a valid API key below in order to properly connect to the Labelbox Client."
],
"cell_type": "markdown"
]
},
{
"metadata": {},
"source": "# Add your API key\nAPI_KEY = None\n# To get your API key go to: Workspace settings -> API -> Create API Key\nclient = lb.Client(api_key=API_KEY)",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"# Add your API key\n",
"API_KEY = None\n",
"# To get your API key go to: Workspace settings -> API -> Create API Key\n",
"client = lb.Client(api_key=API_KEY)"
]
},
{
"metadata": {},
"source": "# For the purpose of this demo get a single project/dataset id from your organization\n\n# Get a single Project id\n# get_projects returns a PaginatedCollection object, which is iterable.\nproject = next(client.get_projects())\nproject_id = project.uid\nproject_name = project.name\nprint(\"Project ID: \", project_id)\nprint(\"Project Name:\", project_name)\n\nprint(\"-\" * 40)\n\n# Get a single dataset id\n# get_datasets returns a PaginatedCollection object, which is iterable.\ndataset = next(client.get_datasets())\ndataset_id = dataset.uid\ndataset_name = dataset.name\nprint(\"Dataset ID: \", dataset_id)\nprint(\"Dataset Name:\", dataset_name)",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"# For the purpose of this demo get a single project/dataset id from your organization\n",
"\n",
"# Get a single Project id\n",
"# get_projects returns a PaginatedCollection object, which is iterable.\n",
"project = next(client.get_projects())\n",
"project_id = project.uid\n",
"project_name = project.name\n",
"print(\"Project ID: \", project_id)\n",
"print(\"Project Name:\", project_name)\n",
"\n",
"print(\"-\" * 40)\n",
"\n",
"# Get a single dataset id\n",
"# get_datasets returns a PaginatedCollection object, which is iterable.\n",
"dataset = next(client.get_datasets())\n",
"dataset_id = dataset.uid\n",
"dataset_name = dataset.name\n",
"print(\"Dataset ID: \", dataset_id)\n",
"print(\"Dataset Name:\", dataset_name)"
]
},
{
"metadata": {},
"source": "# Fetch the project and dataset by using the IDs fetched in the previous cell\nproject = client.get_project(project_id)\ndataset = client.get_dataset(dataset_id)",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"# Fetch the project and dataset by using the IDs fetched in the previous cell\n",
"project = client.get_project(project_id)\n",
"dataset = client.get_dataset(dataset_id)"
]
},
{
"metadata": {},
"source": "print(\"Project: \", project)\nprint(\"Dataset: \", dataset)",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"print(\"Project: \", project)\n",
"print(\"Dataset: \", dataset)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Fields\n",
"* All db objects have fields (look at the source code to see them https://github.com/Labelbox/labelbox-python/blob/develop/labelbox/schema/project.py)\n",
"* These fields are attributes of the object"
],
"cell_type": "markdown"
]
},
{
"metadata": {},
"source": "print(project.name)\nprint(dataset.name)",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"print(project.name)\n",
"print(dataset.name)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"* Fields can be updated. This will be reflected server side (you will see it in labelbox) "
],
"cell_type": "markdown"
]
},
{
"metadata": {},
"source": "project.update(description=\"new description field\")\nprint(project.description)",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"project.update(description=\"new description field\")\n",
"print(project.description)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Pagination\n",
"* Queries that return a list of database objects are return as a PaginatedCollection\n",
"* Limits the data that is being returned for better performance"
],
"cell_type": "markdown"
]
},
{
"metadata": {},
"source": "labels_paginated_collection = project.labels()\nprint(\"Type of collection: \", type(labels_paginated_collection))\n\n# A paginated collection can be parsed by using list()\n# list(paginated...) should be avoided for queries that could return more than a dozen results\nprint(\"Number of labels :\", len(list(labels_paginated_collection)))",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"labels_paginated_collection = project.labels()\n",
"print(\"Type of collection: \", type(labels_paginated_collection))\n",
"\n",
"# A paginated collection can be parsed by using list()\n",
"# list(paginated...) should be avoided for queries that could return more than a dozen results\n",
"print(\"Number of labels :\", len(list(labels_paginated_collection)))"
]
},
{
"metadata": {},
"source": "# Note that if you selected a `project_id` without any labels this will raise `StopIteration`\n# Iterate over the paginated collection\ntry:\n single_label = next(project.labels())\n print(single_label)\nexcept StopIteration:\n print(\"Project has no labels !\")",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"# Note that if you selected a `project_id` without any labels this will raise `StopIteration`\n",
"# Iterate over the paginated collection\n",
"try:\n",
" single_label = next(project.labels())\n",
" print(single_label)\n",
"except StopIteration:\n",
" print(\"Project has no labels !\")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Query parameters\n",
"* Query with the following conventions:\n",
" * `DbObject.Field`"
],
"cell_type": "markdown"
]
},
{
"metadata": {},
"source": "datasets = client.get_datasets(where=lb.Dataset.name == dataset_name)\n\nprojects = client.get_projects(\n where=((lb.Project.name == project_name) &\n (lb.Project.description == \"new description field\")))\n\n# The above two queries return PaginatedCollections because the filter parameters aren't guaranteed to be unique.\n# So even if there is one element returned it is in a paginatedCollection.\nprint(projects)\nprint(next(projects, None))\nprint(next(projects, None))\nprint(next(projects, None))\n# We can see there is only one.",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"datasets = client.get_datasets(where=lb.Dataset.name == dataset_name)\n",
"\n",
"projects = client.get_projects(\n",
" where=((lb.Project.name == project_name) &\n",
" (lb.Project.description == \"new description field\")))\n",
"\n",
"# The above two queries return PaginatedCollections because the filter parameters aren't guaranteed to be unique.\n",
"# So even if there is one element returned it is in a paginatedCollection.\n",
"print(projects)\n",
"print(next(projects, None))\n",
"print(next(projects, None))\n",
"print(next(projects, None))\n",
"# We can see there is only one."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Querying Limitations\n",
"* The DbObject used for the query must be the same as the DbObject returned by the querying function. \n",
"* The below query is not valid since get_project returns a project not a dataset\n",
"> `>>> projects = client.get_projects(where = lb.Dataset.name == \"dataset_name\")`\n"
],
"cell_type": "markdown"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Relationships between projects and batches/datasets\n",
"\n"
],
"cell_type": "markdown"
]
},
{
"metadata": {},
"source": "sample_project_batches = project.batches()\n\nlist(sample_project_batches)\n\nfor b in sample_project_batches:\n print(f\" Name of project : {b.project().name}\")\n print(f\" Name of batches in project: {b.name}\")",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"execution_count": null
"source": [
"sample_project_batches = project.batches()\n",
"\n",
"list(sample_project_batches)\n",
"\n",
"for b in sample_project_batches:\n",
" print(f\" Name of project : {b.project().name}\")\n",
" print(f\" Name of batches in project: {b.name}\")"
]
}
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"name": "python",
"version": "3.12.3"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
Loading
Loading