MMdeploy build & install script + prerequisites #399

tehkillerbee · 2022-04-24T15:32:50Z

Hello,

Over the last couple of months, I have been working on a bash script for building and installing MMDeploy and prerequisites to ease the install procedure when we use MMDetection, MMDeploy tools. Maybe this script can serve as a starting point for an easier install procedure when building and installing MMDeploy from source.

Naturally, this script is a work in progress. There are probably parts that can be cleaned up - and maybe some dependencies are not needed to install anymore.

Let me know if there are any suggestions and ideas on how to integrate this script with the MMDeploy

Note:

Only tested with "standard" python virtual environment, as I do not use Conda
Only tested on linux
Only supports TensorRT build at this point.
The script should work on both x86_64 and aarch64 (jetson) platforms.

codecov · 2022-04-24T15:53:40Z

Codecov Report

Merging #399 (56ff03b) into dev-v0.5.0 (2265217) will decrease coverage by 0.01%.
The diff coverage is 66.66%.

❗ Current head 56ff03b differs from pull request most recent head 178dfc2. Consider uploading reports for the commit 178dfc2 to get more accurate results

@@              Coverage Diff               @@
##           dev-v0.5.0     #399      +/-   ##
==============================================
- Coverage       62.62%   62.60%   -0.02%     
==============================================
  Files             219      220       +1     
  Lines            7291     7312      +21     
  Branches         1120     1126       +6     
==============================================
+ Hits             4566     4578      +12     
- Misses           2402     2410       +8     
- Partials          323      324       +1

Flag	Coverage Δ
unittests	`62.60% <66.66%> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
mmdeploy/core/rewriters/rewriter_utils.py	`93.28% <ø> (ø)`
...y/codebase/mmedit/deploy/super_resolution_model.py	`77.77% <25.00%> (ø)`
...oy/codebase/mmdet/deploy/object_detection_model.py	`83.39% <100.00%> (ø)`
mmdeploy/codebase/base/backend_model.py	`46.93% <0.00%> (-3.07%)`	⬇️
mmdeploy/codebase/mmdet/deploy/utils.py	`86.20% <0.00%> (-0.89%)`	⬇️
mmdeploy/pytorch/ops/__init__.py	`100.00% <0.00%> (ø)`
mmdeploy/pytorch/functions/__init__.py	`100.00% <0.00%> (ø)`
...eploy/codebase/mmdet/models/roi_heads/bbox_head.py	`75.60% <0.00%> (ø)`
...loy/codebase/mmdet/models/dense_heads/yolo_head.py	`70.96% <0.00%> (ø)`
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 89204d1...178dfc2. Read the comment docs.

lvhan028

First of all, I suggest changing the target branch of this PR to dev-v0.5.0. We would like to make this one a new feature of MMDeploy and announce it when releasing v0.5.0.

build_mmdeploy.sh

lvhan028

It seems this script targets NVIDIA devices and Linux OS. So perhaps it can be renamed as build_linux_nvidia.sh or something like that.

build_mmdeploy.sh

grimoire · 2022-04-25T03:48:10Z

The install script of anaconda provides some interactive operations to custom the build. For example:

Anaconda3 will now be installed into this location:
/home/MyHome/anaconda3

  - Press ENTER to confirm the location
  - Press CTRL-C to abort the installation
  - Or specify a different location below

[/home/MyHome/anaconda3] >>>

You can also silence install by adding some other flags. This seems like a good way to custom the build. What do you think @lvhan028 @tehkillerbee

tehkillerbee · 2022-04-25T05:01:35Z

The install script of anaconda provides some interactive operations to custom the build. For example:
Anaconda3 will now be installed into this location:
/home/MyHome/anaconda3

  - Press ENTER to confirm the location
  - Press CTRL-C to abort the installation
  - Or specify a different location below

[/home/MyHome/anaconda3] >>> 
You can also silence install by adding some other flags. This seems like a good way to custom the build. What do you think @lvhan028 @tehkillerbee

This sounds like a good idea for an interactive install procedure. The default options can then be used for an unattended install.

lvhan028 · 2022-04-25T07:14:22Z

The install script of anaconda provides some interactive operations to custom the build. For example:
Anaconda3 will now be installed into this location:
/home/MyHome/anaconda3

  - Press ENTER to confirm the location
  - Press CTRL-C to abort the installation
  - Or specify a different location below

[/home/MyHome/anaconda3] >>> 
You can also silence install by adding some other flags. This seems like a good way to custom the build. What do you think @lvhan028 @tehkillerbee

Sounds great

tehkillerbee · 2022-04-30T17:15:33Z

I have updated the PR with most of the comments you both suggested. Whats left is to make the install more interactive and also make it unattended. @lvhan028 @grimoire

grimoire · 2022-05-01T02:16:08Z

Hi, could you drop the unrelated commit (which comes from master branch).

tehkillerbee · 2022-05-01T20:28:22Z

Hi, could you drop the unrelated commit (which comes from master branch).

I tried to cherry pick the related commits and apply them to the dev v0.5.0 instead. Does it look OK to you?

tehkillerbee · 2022-05-01T20:30:04Z

The install script of anaconda provides some interactive operations to custom the build. For example:
Anaconda3 will now be installed into this location:
/home/MyHome/anaconda3

  - Press ENTER to confirm the location
  - Press CTRL-C to abort the installation
  - Or specify a different location below

[/home/MyHome/anaconda3] >>> 
You can also silence install by adding some other flags. This seems like a good way to custom the build. What do you think

@grimoire Regarding interactive install, should I just attempt to replicate the behaviour used by the anaconda installer or is there a install script I can use as a base?

grimoire · 2022-05-02T02:07:13Z

We do not have a base script, it is ok to replicate the behavior of anaconda or you can design your own pattern.

grimoire · 2022-05-03T03:19:28Z

I tried to cherry pick the related commits and apply them to the dev v0.5.0 instead. Does it look OK to you?

You can rebase -i and drop the commit from master(if they are not required for the build script).

build_linux_nvidia.sh

lvhan028 · 2022-05-07T09:08:40Z

Hi, @tehkillerbee. I think you can work on dev-v0.5.0 branch since there are lots of unrelated commits from master.

* Auto detect installed version of cmake, gcc. Update if necessary * Prompt to reinstall venv if exists * Disable .tar packing * Enable MMDEPLOY SDK Python * Misc cleanup

lvhan028 · 2022-05-11T06:30:21Z

@lvhan028 I am going to add silent mode as part of the interactive install. I.e. if the script is executed with a silent argument, it will use the default selections for all prompts.

Will it be OK to use the default selections or will it be necessary to override them somehow?

Using the default selections is fine. Thanks a lot

build_linux_nvidia.sh

lvhan028 · 2022-05-17T00:43:59Z

Hi, @tehkillerbee can you provide a build method?
Here is what I do in my conda environment:

git clone --recursive https://github.com/open-mmlab/mmdeploy.git
cd mmdeploy
./build_linux_nvidia.sh mmdeploy

But I got failures like,

Build and install 'mmdeploy'...
cat: MMDeploy/mmdeploy/version.py: No such file or directory
./build_linux_nvidia.sh: line 314: /home/PJLAB/lvhan/Documents/projects/open-mmlab/mmdeploy/venv-mmdeploy/bin/activate: No such file or directory

tehkillerbee · 2022-05-17T05:52:02Z

Hi, @tehkillerbee can you provide a build method? Here is what I do in my conda environment:

git clone --recursive https://github.com/open-mmlab/mmdeploy.git
cd mmdeploy
./build_linux_nvidia.sh mmdeploy

But I got failures like,

Build and install 'mmdeploy'...
cat: MMDeploy/mmdeploy/version.py: No such file or directory
./build_linux_nvidia.sh: line 314: /home/PJLAB/lvhan/Documents/projects/open-mmlab/mmdeploy/venv-mmdeploy/bin/activate: No such file or directory

Hi, @tehkillerbee can you provide a build method? Here is what I do in my conda environment:

git clone --recursive https://github.com/open-mmlab/mmdeploy.git
cd mmdeploy
./build_linux_nvidia.sh mmdeploy

But I got failures like,

Build and install 'mmdeploy'...
cat: MMDeploy/mmdeploy/version.py: No such file or directory
./build_linux_nvidia.sh: line 314: /home/PJLAB/lvhan/Documents/projects/open-mmlab/mmdeploy/venv-mmdeploy/bin/activate: No such file or directory

I think that is related to the issue mentioned by @grimoire. Initially my script assumed that a MMDeploy folder is found in the root directory. But since the root dir is now MMDeploy, there are some paths that are now incorrect. I will fix it now!

* Make prebuild archive optional. * Add venv* to gitignore

…mments.

tehkillerbee · 2022-05-19T15:06:24Z

@lvhan028 The script can now run as unattended/auto but it is not strictly silent. Instead, all user interaction is skipped.

The default options might need to be changed to something more suitable.

You should be able to run it in this way:

./build_linux_nvidia.sh mmdeploy auto

build_linux_nvidia.sh

grimoire · 2022-05-20T10:04:20Z

Good to me. Any advice @lvhan028

build_linux_nvidia.sh

lvhan028 · 2022-05-23T09:00:10Z

Can we put this script to tools/scripts/?

* Mention default option when reinstalling venv * sudo make install instead of cmake --install

tehkillerbee · 2022-05-24T05:18:04Z

@lvhan028 Updated PR according to your comments

tools/scripts/build_linux_nvidia.sh

grimoire

LGTM

* Initial commit of build script * Fixed lint * * Set prefix depending on install arch * Auto detect installed version of cmake, gcc. Update if necessary * Prompt to reinstall venv if exists * Disable .tar packing * Enable MMDEPLOY SDK Python * Misc cleanup * Fixed lint * Renamed script * * Set env variables without restarting script. * OpenCV install optional. * Fix numpy OPENBLAS_CORETYPE on numpy >1.19.4. * Remove specific build files. * Fix prebuild output .tar.gz. * Comments added. exec bash when closing script * * Use root dir as MMDeploy dir. * Use pip3. * Remove explicit MMDeploy checkout version. * Use MMDEPLOY_DIR for examples path * Make PyTorch, torchvision, mmcv install optional * * Do not deactivate python venv. * Make prebuild archive optional. * Add venv* to gitignore * * Add support for unattended, interactive install. * Cleanup misc. comments. * Check input arguments before continuing. * Added additional log messages, comments added * Added default option when pressing [ENTER] * * Rearranged cmake, gcc build/install order. * Mention default option when reinstalling venv * sudo make install instead of cmake --install * Moved script to tools/scripts * Fixed relative path when generating WORKING_DIR

grimoire requested review from grimoire and lvhan028 April 25, 2022 02:07

lvhan028 reviewed Apr 25, 2022

View reviewed changes

build_mmdeploy.sh Outdated Show resolved Hide resolved

lvhan028 reviewed Apr 25, 2022

View reviewed changes

build_mmdeploy.sh Outdated Show resolved Hide resolved

lvhan028 reviewed Apr 25, 2022

View reviewed changes

build_mmdeploy.sh Outdated Show resolved Hide resolved

tehkillerbee changed the base branch from master to dev-v0.5.0 April 26, 2022 14:37

tehkillerbee mentioned this pull request May 1, 2022

MMDeploy on Jetson AGX Xavier #429

Closed

grimoire reviewed May 3, 2022

View reviewed changes

build_linux_nvidia.sh Outdated Show resolved Hide resolved

grimoire reviewed May 3, 2022

View reviewed changes

build_linux_nvidia.sh Outdated Show resolved Hide resolved

grimoire reviewed May 3, 2022

View reviewed changes

build_linux_nvidia.sh Outdated Show resolved Hide resolved

grimoire reviewed May 3, 2022

View reviewed changes

build_linux_nvidia.sh Outdated Show resolved Hide resolved

grimoire reviewed May 3, 2022

View reviewed changes

build_linux_nvidia.sh Outdated Show resolved Hide resolved

Johannes Linde added 5 commits May 9, 2022 08:00

Initial commit of build script

454c9f4

Fixed lint

2b0461d

* Set prefix depending on install arch

0ff5c5e

* Auto detect installed version of cmake, gcc. Update if necessary * Prompt to reinstall venv if exists * Disable .tar packing * Enable MMDEPLOY SDK Python * Misc cleanup

Fixed lint

90a5051

Renamed script

05f67d5

grimoire reviewed May 13, 2022

View reviewed changes

build_linux_nvidia.sh Outdated Show resolved Hide resolved

grimoire reviewed May 13, 2022

View reviewed changes

build_linux_nvidia.sh Outdated Show resolved Hide resolved

grimoire reviewed May 13, 2022

View reviewed changes

build_linux_nvidia.sh Outdated Show resolved Hide resolved

* Do not deactivate python venv.

cc4d26a

* Make prebuild archive optional. * Add venv* to gitignore

tehkillerbee mentioned this pull request May 18, 2022

[Enhancement] make build script for windows platform #486

Open

* Add support for unattended, interactive install. * Cleanup misc. co…

ebe88ff

…mments.

Johannes Linde added 2 commits May 20, 2022 07:45

Check input arguments before continuing.

9a2885b

Added additional log messages, comments added

f6f11f0

grimoire reviewed May 20, 2022

View reviewed changes

build_linux_nvidia.sh Show resolved Hide resolved

grimoire reviewed May 20, 2022

View reviewed changes

build_linux_nvidia.sh Show resolved Hide resolved

Added default option when pressing [ENTER]

f467c6e

lvhan028 reviewed May 23, 2022

View reviewed changes

build_linux_nvidia.sh Outdated Show resolved Hide resolved

build_linux_nvidia.sh Show resolved Hide resolved

build_linux_nvidia.sh Outdated Show resolved Hide resolved

Johannes Linde added 2 commits May 23, 2022 12:59

* Rearranged cmake, gcc build/install order.

06f8d78

* Mention default option when reinstalling venv * sudo make install instead of cmake --install

Moved script to tools/scripts

e15f0f7

lvhan028 reviewed May 25, 2022

View reviewed changes

tools/scripts/build_linux_nvidia.sh Outdated Show resolved Hide resolved

Johannes Linde added 2 commits May 25, 2022 08:45

Fixed relative path when generating WORKING_DIR

ee3f7bd

Merge branch 'dev-v0.5.0' into install_script

178dfc2

lvhan028 approved these changes May 25, 2022

View reviewed changes

grimoire approved these changes May 25, 2022

View reviewed changes

grimoire merged commit 651eec2 into open-mmlab:dev-v0.5.0 May 25, 2022

MMdeploy build & install script + prerequisites #399

MMdeploy build & install script + prerequisites #399

Uh oh!

Conversation

tehkillerbee commented Apr 24, 2022

Uh oh!

codecov bot commented Apr 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

lvhan028 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lvhan028 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

grimoire commented Apr 25, 2022

Uh oh!

tehkillerbee commented Apr 25, 2022

Uh oh!

lvhan028 commented Apr 25, 2022

Uh oh!

tehkillerbee commented Apr 30, 2022

Uh oh!

grimoire commented May 1, 2022

Uh oh!

tehkillerbee commented May 1, 2022

Uh oh!

tehkillerbee commented May 1, 2022

Uh oh!

grimoire commented May 2, 2022

Uh oh!

grimoire commented May 3, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lvhan028 commented May 7, 2022

Uh oh!

lvhan028 commented May 11, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lvhan028 commented May 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tehkillerbee commented May 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tehkillerbee commented May 19, 2022

Uh oh!

Uh oh!

Uh oh!

grimoire commented May 20, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lvhan028 commented May 23, 2022

Uh oh!

tehkillerbee commented May 24, 2022

Uh oh!

Uh oh!

grimoire left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Apr 24, 2022 •

edited

Loading

lvhan028 commented May 17, 2022 •

edited

Loading

tehkillerbee commented May 17, 2022 •

edited

Loading