Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc]: Add document of TensorRT and onnxruntime custom ops #920

Merged
merged 11 commits into from
Apr 12, 2021

Conversation

grimoire
Copy link
Member

@grimoire grimoire commented Apr 2, 2021

This PR adds detailed documents of TensorRT and onnxruntime custom ops.

The documents share the same format as onnx document.
Headers like Description Parameters use HTML tags instead of markdown to avoid MD024 check.

Note that sphinx on my device can not convert relative path like ./tensorrt_custom_ops.md#mmcvroialign in tensorrt_plugin.md to HTML. I have no idea how to fix it.

@codecov
Copy link

codecov bot commented Apr 2, 2021

Codecov Report

Merging #920 (1acaba5) into master (9d80f56) will increase coverage by 0.79%.
The diff coverage is 66.89%.

❗ Current head 1acaba5 differs from pull request most recent head 3bbb7bc. Consider uploading reports for the commit 3bbb7bc to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master     #920      +/-   ##
==========================================
+ Coverage   64.86%   65.66%   +0.79%     
==========================================
  Files         148      149       +1     
  Lines        9193     9447     +254     
  Branches     1647     1718      +71     
==========================================
+ Hits         5963     6203     +240     
- Misses       2903     2924      +21     
+ Partials      327      320       -7     
Flag Coverage Δ
unittests 65.66% <66.89%> (+0.79%) ⬆️

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

Impacted Files Coverage Δ
mmcv/cnn/bricks/conv.py 100.00% <ø> (ø)
mmcv/engine/test.py 26.88% <26.88%> (ø)
mmcv/ops/deform_conv.py 61.76% <31.25%> (-4.36%) ⬇️
mmcv/runner/hooks/logger/wandb.py 68.75% <40.00%> (-6.25%) ⬇️
mmcv/runner/hooks/momentum_updater.py 60.60% <58.33%> (+2.27%) ⬆️
mmcv/runner/hooks/lr_updater.py 65.78% <62.22%> (+8.96%) ⬆️
mmcv/runner/hooks/evaluation.py 87.24% <87.24%> (ø)
mmcv/cnn/__init__.py 100.00% <100.00%> (ø)
mmcv/cnn/builder.py 100.00% <100.00%> (ø)
mmcv/cnn/utils/weight_init.py 91.66% <100.00%> (+0.09%) ⬆️
... and 17 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 9d80f56...3bbb7bc. Read the comment docs.

@RunningLeon RunningLeon self-requested a review April 6, 2021 08:29
@RunningLeon RunningLeon changed the title Add document of TensorRT and onnxruntime custom ops. [Doc]: Add document of TensorRT and onnxruntime custom ops Apr 6, 2021
docs/onnxruntime_op.md Outdated Show resolved Hide resolved
@RunningLeon RunningLeon requested a review from ZwwWayne April 8, 2021 06:50
docs/onnxruntime_op.md Outdated Show resolved Hide resolved
docs/onnxruntime_op.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@RunningLeon RunningLeon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hellock
Copy link
Member

hellock commented Apr 10, 2021

We can set the argument allow_different_nesting to true to avoid MD024, as described in the doc.

@ZwwWayne ZwwWayne merged commit e478e9f into open-mmlab:master Apr 12, 2021
@grimoire grimoire deleted the ops_document branch September 15, 2021 03:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants