superb-ai-label 0.21.3

Suite Standard Library

Superb AI Suite Software Development Kit

Official Superb AI Suite Software Development Kit for managing data and labels on Superb AI Suite.

• Installation
• Authentication
• Resource Description
  • Projects
  • Labels
• Contributing
• License

Installation

$ pip install spb-sdk

0.0.xx

Authentication

You need an Access Key for authentication. The Access Key can be generated on the :tada: Superb AI Suite web (Suite > My Account > Advanced).

You can then configure your profile by entering your Suite Team Name and the generated Access Key to under configuration file.

:rotating_light: Suite Team Name refers to the organization name that your personal account belongs to:

$ cat <<EOF >> ~/.spb/config
[default]
team_name = YOUR TEAM NAME
access_key = GENERATED TEAM ACCESS KEY
EOF

Resource Description

Projects

from spb_label import sdk

client = sdk.Client()
# Get all projects
count, projects = client.get_projects()
# Set project to client what to handle
client.set_project(projects[0])
# Get project name and id
client.get_project_name()
client.get_project_id()

# Get all project users
count, users = client.get_project_users()

# Get project tags
count, tags = client.get_project_tags()

Labels

from spb_label import sdk
from spb_label.utils import SearchFilter

client = sdk.Client()
client.set_project(name="YOUR PROJECT NAME")

# Get labels
filter = SearchFilter(project=client.project)

# Status filter
filter.status_is_any_one_of = ["WORKING", "SKIPPED"]
# Assignee filter
filter.assignee_is_any_one_of = ["ASSIGNEE EMAIL"]
# Tag filter
filter.tag_name_all = ["TAG NAME"]

count, labels, next = client.get_labels(
  filter=filter,
  cursor=next
)

Contributing

Feel free to report issues and suggest improvements.
Please email us at [e-mail]

License

The MIT License (MIT)

Copyright (c) 2020, Superb AI, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.