Metadata-Version: 2.1
Name: amodel
Version: 0.1.0
Summary: Apollo's model deployment and management tool
Home-page: https://github.com/ApolloAuto/apollo/tree/master/modules/tools/amodel
Author: apollo-team
Author-email: apollo-support@baidu.com
Project-URL: Bug Tracker, https://github.com/ApolloAuto/apollo/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

## amodel
`amodel` is Apollo's model deployment and management tool.

## Install
You can use below command to install `amodel`.
```python
pip3 install -t /opt/apollo/python_tools amodel
```

## Set environment
If you are running in Apollo docker, you can skip this step. If you are running outside of docker, the following environment needs to be set up.
```shell
export APOLLO_ROOT_DIR=your_apollo_dir
```

## How to work
`amodel` provides the following commands:
- list. Show models installed in Apollo.
- info. Show details of a model.
- install. Install the model to Apollo.
- remove. Remove the model from Apollo.

#### List
You can get the installed models in Apollo through the `list` command.
```shell
$ amodel list
Name                |Task_type           |Sensor_type         |Framework           |Date
mask_pillars        |3d_detection        |lidar               |paddlepaddle        |2021-07-30
center_point        |3d_detection        |lidar               |paddlepaddle        |2022-07-22
point_pillars       |3d_detection        |lidar               |paddlepaddle        |2020-12-15
cnnseg16            |3d_segmentation     |lidar               |paddlepaddle        |2018-10-14
cnnseg128           |3d_segmentation     |lidar               |paddlepaddle        |2020-06-17
cnnseg64            |3d_segmentation     |lidar               |paddlepaddle        |2019-05-29
smoke               |3d_detection        |camera              |paddlepaddle        |2019-06-27
3d-yolo             |3d_detection        |camera              |paddlepaddle        |2019-12-08
denseline           |lane_detection      |camera              |paddlepaddle        |2019-05-29
darkSCNN            |lane_detection      |camera              |paddlepaddle        |2020-12-15
tl_detection        |tl_detection        |camera              |paddlepaddle        |2021-01-15
tl_recognition      |tl_recognition      |camera              |paddlepaddle        |2021-01-15
```

#### Info
Then you can use the `info` command to learn more about the details of the model.
```shell
$ amodel info point_pillars
name: point_pillars
date: 2020-12-15
task_type: 3d_detection
sensor_type: lidar
framework: paddlepaddle
model_files:
- name: pfe.onnx
  size: 4125
- name: pts_backbone.zip
  size: 16945051
- name: pts_bbox_head.zip
  size: 121150
- name: pts_middle_encoder.zip
  size: 3763
- name: pts_neck.zip
  size: 2420625
- name: pts_voxel_encoder.zip
  size: 17575
- name: rpn.onnx
  size: 18300546
dataset:
- waymo
- kitti
- nusense
```

#### Install
You can deploy the model using the `install` command.
```shell
# Install from local
amodel install xxx.zip
# Install from http
amodel install https://xxx.zip
```

#### Remove
You can delete models installed in Apollo with the `remove` command.
```shell
amodel remove point_pillars
```
