-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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]translate doc for docs/zh_cn/user_guides/5_deployment.md #3281
Conversation
@AI-Tianlong 麻烦帮我review一下 |
😍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you add an instruction to install mmdeploy using mim?
docs/en/user_guides/5_deployment.md
Outdated
--cfg-options \ | ||
model.test_cfg.mode="whole" | ||
``` | ||
[MMSegmentation](https://github.com/open-mmlab/mmsegmentation/tree/main), also known as `mmseg`, is an open source object segmentation toolbox based on Pytorch. It's a part of the [OpenMMLab](<(https://openmmlab.com/)>) object. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[MMSegmentation](https://github.com/open-mmlab/mmsegmentation/tree/main), also known as `mmseg`, is an open source object segmentation toolbox based on Pytorch. It's a part of the [OpenMMLab](<(https://openmmlab.com/)>) object. | |
[MMSegmentation](https://github.com/open-mmlab/mmsegmentation/tree/main), also known as `mmseg`, is an open source semantic segmentation toolbox based on Pytorch. It's part of the [OpenMMLab](<(https://openmmlab.com/)>) object. |
docs/en/user_guides/5_deployment.md
Outdated
|
||
Description of arguments: | ||
Following installation for mmdeploy: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Following installation for mmdeploy: | |
`mmdeploy` can be installed as follows: |
docs/en/user_guides/5_deployment.md
Outdated
- `--verify`: Determines whether to verify the correctness of an exported model. If not specified, it will be set to `False`. | ||
- `--dynamic-export`: Determines whether to export ONNX model with dynamic input and output shapes. If not specified, it will be set to `False`. | ||
- `--cfg-options`:Update config options. | ||
**The first way to install:** Install precompiled package |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
**The first way to install:** Install precompiled package | |
**Option 1:** Install precompiled package |
docs/en/user_guides/5_deployment.md
Outdated
::: | ||
Please follow the [Installation overview](https://mmdeploy.readthedocs.io/zh_CN/latest/get_started.html#mmdeploy) | ||
|
||
**The second way to install:** Automatic Installation script |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
**The second way to install:** Automatic Installation script | |
**Option 2:** Automatic Installation script |
docs/en/user_guides/5_deployment.md
Outdated
|
||
### Prerequisite | ||
**The third way to install:** Build MMDeploy from source |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
**The third way to install:** Build MMDeploy from source | |
**Option 3:** Build MMDeploy from source |
Option 4? |
已添加 |
…mmlab#3281) Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers. ## Motivation translate doc for docs/zh_cn/user_guides/5_deployment.md ## Modification update `docs/en/user_guides/5_deployment.md` fix `docs/zh_cn/user_guides/5_deployment.md` ## BC-breaking (Optional) Does the modification introduce changes that break the backward-compatibility of the downstream repos? If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR. ## Use cases (Optional) If this PR introduces a new feature, it is better to list some use cases here, and update the documentation. ## Checklist 1. Pre-commit or other linting tools are used to fix the potential lint issues. 2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness. 3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMDet3D. 4. The documentation has been modified accordingly, like docstring or example tutorials. --------- Co-authored-by: 谢昕辰 <xiexinch@outlook.com>
…mmlab#3281) Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers. ## Motivation translate doc for docs/zh_cn/user_guides/5_deployment.md ## Modification update `docs/en/user_guides/5_deployment.md` fix `docs/zh_cn/user_guides/5_deployment.md` ## BC-breaking (Optional) Does the modification introduce changes that break the backward-compatibility of the downstream repos? If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR. ## Use cases (Optional) If this PR introduces a new feature, it is better to list some use cases here, and update the documentation. ## Checklist 1. Pre-commit or other linting tools are used to fix the potential lint issues. 2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness. 3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMDet3D. 4. The documentation has been modified accordingly, like docstring or example tutorials. --------- Co-authored-by: 谢昕辰 <xiexinch@outlook.com>
Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.
Motivation
translate doc for docs/zh_cn/user_guides/5_deployment.md
Modification
update
docs/en/user_guides/5_deployment.md
fix
docs/zh_cn/user_guides/5_deployment.md
BC-breaking (Optional)
Does the modification introduce changes that break the backward-compatibility of the downstream repos?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.
Use cases (Optional)
If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.
Checklist