Skip to content

Commit 6b32fa3

Browse files
authored
Documentation update for automotive minified benchmark (BEVFormer) update docs (#366)
Updating documentation for new minified automotive benchmark `BEVFormer`: - Reference benchmark implementation: https://github.com/mlcommons/mlperf_automotive/tree/master/automotive/camera-3d-detection - Original benchmark: https://github.com/fundamentalvision/BEVFormer
1 parent 923097c commit 6b32fa3

3 files changed

Lines changed: 74 additions & 0 deletions

File tree

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Automotive - BEVFormer
2+
3+
The benchmark reference for BEVFormer can be found in this [link](https://github.com/mlcommons/mlperf_automotive/tree/master/automotive/camera-3d-detection), and here is the PR for the minified benchmark implementation: [link](https://github.com/mlcommons/mlperf_automotive/pull/87).
4+
5+
## Project setup
6+
7+
An important requirement is that you must have Docker installed.
8+
9+
```bash
10+
# Create Python environment and install MLCube Docker runner
11+
virtualenv -p python3 ./env && source ./env/bin/activate && pip install pip==24.0 && pip install mlcube-docker
12+
# Fetch the implementation from GitHub
13+
git clone https://github.com/mlcommons/mlperf_automotive && cd ./mlperf_automotive
14+
git fetch origin pull/87/head:feature/mlcube_bevformer && git checkout feature/mlcube_bevformer
15+
cd ./automotive/camera-3d-detection/mlcube
16+
```
17+
18+
Inside the mlcube directory run the following command to check implemented tasks.
19+
20+
```shell
21+
mlcube describe
22+
```
23+
24+
###  Extra requirements
25+
26+
You need to run these steps locally.
27+
28+
```shell
29+
pip install mlc-scripts
30+
```
31+
32+
Then run this command and follow the instructions.
33+
34+
```shell
35+
mlcr get,bevformer,_mlc,_rclone
36+
```
37+
38+
After this you will have a new configuration at `~/.config/rclone/rclone.conf`.
39+
40+
Finally you just need to copy that file into the `workpace` folder.
41+
42+
```shell
43+
cp ~/.config/rclone/rclone.conf workspace
44+
```
45+
46+
### MLCube tasks
47+
48+
* Demo tasks:
49+
50+
Download demo dataset and models.
51+
52+
```shell
53+
mlcube run --task=download_demo -Pdocker.build_strategy=always
54+
```
55+
56+
Train demo.
57+
58+
```shell
59+
mlcube run --task=demo -Pdocker.build_strategy=always
60+
```
61+
62+
### Execute the complete pipeline
63+
64+
You can execute the complete pipeline with one single command.
65+
66+
* Demo pipeline:
67+
68+
```shell
69+
mlcube run --task=download_demo,demo -Pdocker.build_strategy=always
70+
```
71+
72+
**Note**: To rebuild the image use the flag: `-Pdocker.build_strategy=always` during the `mlcube run` command.

docs/minified-benchmarks/introduction.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ The main advantages of these minified benchmarks are:
1919
- [Bert](bert.md)
2020
- [Object Detection](object-detection.md)
2121
- [Graph Neural Network](gnn.md)
22+
- [Automotive - BEVFormer](automotive.md)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ nav:
3535
- Bert: minified-benchmarks/bert.md
3636
- Object Detection: minified-benchmarks/object-detection.md
3737
- Graph Neural Network: minified-benchmarks/gnn.md
38+
- Automotive - BEVFormer: minified-benchmarks/automotive.md
3839

3940
theme:
4041
features:

0 commit comments

Comments
 (0)