<!-- <p align="center">
<a href="http://suite-api.superb-ai.com/" target="blank"><img src="logo/cool-tree.png" width="200" height="200" alt="Cool-Tree Logo" /></a>
</p> -->
# Superb AI Suite Command Line Tool
![Build](https://github.com/Superb-AI-Suite/spb-cli/workflows/Build/badge.svg)
![Version](https://img.shields.io/pypi/v/spb-cli)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
<!--![Unit Test](https://github.com/Superb-AI-Suite/cool-tree/workflows/Unit%20Test/badge.svg)-->
Official Superb AI Suite Command Line Interface for managing data and labels on [Superb AI Suite](https://suite.superb-ai.com).
- [Installation](#Installation)
- [Authentication](#Authentication)
- [Resource Description](#Resource-Description)
- [Projects](#Projects)
- [Uploading Dataset](#Uploading-Dataset)
- [Downloading Data & Labels](#Downloading-Data--Labels)
- [Contributing](#Contributing)
- [License](#License)
## Installation
```shell
$ pip install spb-cli
$ spb --version
0.0.xx
```
Once installed, you can type `spb` command in the terminal to access the command line interface.
<!---
<img src="./install-spb-cli.gif" width="600">
-->
## Authentication
<img src="./assets/configure-cli.gif" width="800">
You need an *Access Key* for authentication. The *Access Key* can be generated on the :tada: [Superb AI Suite web](https://suite.superb-ai.com/) (Suite > My Account > Advanced).
You can then configure your profile by entering your *Suite Team Name* and the generated *Access Key*.
:rotating_light: ***Suite Team Name* refers to the organization name that your personal account belongs to:**
<img src="./assets/account-name.png" width="400">
```shell
$ spb configure
Suite Team Name: foo
Access Key: bar
```
Once configured, you can check the currently configured profile by using the `--list` option.
```
$ spb configure --list
[default]
access_key = foo
team_name = bar
```
## Resource Description
### Projects
<img src="./assets/describe-projects.gif" width="800">
You can list all projects that belong to the currently configured profile by using the following command:
```shell
$ spb describe projects
┏━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━┓
┃ NAME ┃ LABELS ┃ IN PROGRESS ┃ SUBMITTED ┃ SKIPPED ┃
┡━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━┩
│ my-project │ 6000 │ 1000 (16 %) │ 2000 (33 %) │ 0 (0 %) │
...
Press any button to continue to the next page (1/10). Otherwise press ‘Q’ to quit.
```
## Uploading Dataset
<img src="./assets/upload.gif" width="800">
You can upload data and create labels for your project with this command line interface.
Move to the dataset directory that has image files (with extension of `.jpg`, `.png`, `.gif`) and upload images in the directory by using the following CLI command:
```shell
$ cd some-folder
$ spb upload dataset
Project Name: my-project
Dataset Name: my-dataset
Uploading 3 data and 0 labels to dataset 'my-dataset' under project 'my-project'. Proceed? [y/N]: y
Uploading data:
100%|██████████████████████████████████████████████████| 3/3 [00:03<00:00, 1.06s/it]
```
If you wish to upload the **label** files along with the dataset, you can enable the `--include-label` option:
```shell
$ cd some-folder
$ spb upload dataset --include-label
Project Name: my-project
Dataset Name: my-dataset
Uploading 3 data and 0 labels to dataset 'my-dataset' under project 'my-project'. Proceed? [y/N]: y
Uploading data:
100%|██████████████████████████████████████████████████| 3/3 [00:03<00:00, 1.06s/it]
Uploading labels:
100%|██████████████████████████████████████████████████| 3/3 [00:03<00:00, 3.40s/it]
```
To learn how to create a **label** JSON file according to the Superb AI format, please refer to the **Annotation JSON File Structure** section in the linked [Superb AI Suite Manual](https://www.notion.so/Export-Result-Format-6d45fca9c85841aea7014372fb3dd2c8#bf31abcd73da4ad899ea05a4b052d262).
<!---
Or if you wish to only upload the **pre-label** :label: files:
```shell
$ spb upload labels
Project Name: my-project
Dataset Name: my-dataset
```
To understand how to construct a **label** JSON file according to the Superb AI format, please refer to the "Annotation JSON File Structure" section in the linked [Superb AI Suite Manual](https://www.notion.so/Export-Result-Format-6d45fca9c85841aea7014372fb3dd2c8#bf31abcd73da4ad899ea05a4b052d262).
-->
## Downloading Data & Labels
<img src="./assets/download.gif" width="800">
You can download images and labels for a project by using the following command:
```shell
$ cd some-folder
$ spb download
Project Name: my-project
Downloading 3 data and 3 labels from project 'my-project' to '.'. Proceed? [y/N]: y
100%|██████████████████████████████████████████████████| 1/1 [00:00<00:00, 1.11it/s]
** Result Summary **
Successful download of 3 out of 3 labels. (100.0%)
Successful download of 3 out of 3 data. (100.0%)
```
The result is saved to the designated directory. For example:
```
└─ some-folder
└─ my-dataset
├─ 1.jpg
├─ 1.jpg.json
├─ 2.jpg
├─ 2.jpg.json
...
```
## Contributing
Feel free to report issues and suggest improvements.
Please email us at support@superb-ai.com
## 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.
没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
收起资源包目录
spb-cli-0.9.0.tar.gz (81个子文件)
spb-cli-0.9.0
PKG-INFO 9KB
setup.cfg 77B
setup.py 2KB
README.md 7KB
spb_cli.egg-info
PKG-INFO 9KB
requires.txt 559B
not-zip-safe 1B
SOURCES.txt 2KB
entry_points.txt 42B
top_level.txt 4B
dependency_links.txt 1B
spb
models
project.py 4KB
video_data.py 2KB
label.py 2KB
video_label.py 2KB
__init__.py 130B
data.py 2KB
core
models
__init__.py 0B
attrs
attributes_container.py 2KB
__init__.py 159B
types
__init__.py 262B
type_base.py 1KB
type.py 9KB
manager.py 742B
__init__.py 54B
query.py 7KB
model.py 6KB
session.py 6KB
command
commands.py 3KB
builder.py 2KB
__init__.py 1KB
cli.py 6KB
datauri
__init__.py 4KB
exceptions.py 134B
exceptions
__init__.py 4KB
__main__.py 61B
sdk.py 20KB
orm
loading.py 4KB
manager.py 2KB
utils.py 839B
json_type.py 1KB
__init__.py 1KB
type_base.py 3KB
query.py 4KB
type.py 4KB
model.py 6KB
__init__.py 3KB
cli_core
helper.py 2KB
commands
label_data.py 19KB
project.py 5KB
video_label_data.py 15KB
__init__.py 0B
utils.py 3KB
__init__.py 0B
sdk_config.py 293B
labels
serializer
label_info_build_params.py 2KB
__init__.py 93B
manager.py 8KB
label.py 3KB
__init__.py 45B
query.py 929B
session.py 927B
projects
manager.py 1KB
project.py 833B
__init__.py 57B
query.py 117B
session.py 1016B
spb_logger.py 2KB
libs
phy_credit
phy_credit
imageV2
label_info.py 7KB
__init__.py 512B
legacy
label_info.py 6KB
__init__.py 25B
__init__.py 23B
video
label_info.py 9KB
__init__.py 512B
legacy
label_info.py 8KB
__init__.py 25B
__init__.py 0B
setup.py 416B
__init__.py 0B
session.py 8KB
共 81 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- 甘晴void:一位多才多艺的编程新星.zip
- 基于C++的App图标资源库设计源码 - libicon
- 基于Java的日记本应用程序设计源码 - Diary
- 基于C#的.NET模板引擎设计源码 - jntemplate
- 基于51单片机+AC24C04+LCD1602显示的电子密码锁程序源代码及电路仿真.zip
- 基于C++的图形共享内存轻量级设计源码 - graphic_surface_lite
- 深入解析指令调度与延迟分支.zip
- 基于STC15F104E系列单片机的EEPROM应用程序测试例程KEIL工程源码.zip
- 基于STC15F104E系列单片机的串口通讯应用程序测试例程KEIL工程源码.zip
- java-leetcode题解之第844题比较含退格的字符串.zip
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功