mmdetection icon indicating copy to clipboard operation
mmdetection copied to clipboard

[Doc]: update user guide: "finetune.md, inference.md"

Open DanShouzhu opened this issue 2 years ago • 4 comments

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

Update user guide based on English version.

Modification

Update Two user guides were updated based on English version

  • docs/zh_cn/user_guides/finetune.md
  • docs/zh_cn/user_guides/inference.md Fixed Fixed a misspelling in inference.md
  • docs/en/user_guides/finetune.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 MMCls.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

DanShouzhu avatar Jan 05 '23 16:01 DanShouzhu

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Jan 05 '23 16:01 CLAassistant

Hi @DanShouzhu , Thanks for your kind contribution. Would you like to fix the lint issue so that we could merge this PR? The details can be found by clicking the item of lint check as shown below image

ZwwWayne avatar Jan 06 '23 07:01 ZwwWayne

@zytx121 Thanks for your review and suggestions, all changes have been accepted. However, it still did not pass tests, would you mind taking a look again?

DanShouzhu avatar Jan 07 '23 13:01 DanShouzhu

Hi @DanShouzhu , Thanks for your kind contribution. Would you like to fix the lint issue so that we could merge this PR? The details can be found by clicking the item of lint check as shown below image

Sure, I have already applied the suggested code changes given by @zytx121.

But, it still did not pass the test system, we will continue to deal with it.

DanShouzhu avatar Jan 07 '23 13:01 DanShouzhu

seems the lint has failed, please fix the lint image

you can follow https://github.com/open-mmlab/mmcv/blob/master/CONTRIBUTING.md

BIGWangYuDong avatar Jan 13 '23 08:01 BIGWangYuDong

@BIGWangYuDong

All checks have passed after using pre-commit.

Thank you so much!

DanShouzhu avatar Jan 15 '23 02:01 DanShouzhu

Hi @DanShouzhu , Is there any progress in this PR?

ZwwWayne avatar Feb 02 '23 03:02 ZwwWayne

Hi @DanShouzhu , Is there any progress in this PR?

Hello Wayne,

I made some updates.

Could you do a code review for this PR?

Best Regards, Cecil Dan

DanShouzhu avatar Feb 05 '23 10:02 DanShouzhu

Hi @DanShouzhu , The overall PR LGTM now and can be merged after fixing these small issues

ZwwWayne avatar Feb 06 '23 02:02 ZwwWayne

Hi @DanShouzhu please also add Objects365 in English documents. Thx!

BIGWangYuDong avatar Feb 08 '23 01:02 BIGWangYuDong

This PR can be merged after fixing these small issues

BIGWangYuDong avatar Feb 08 '23 01:02 BIGWangYuDong

Hi @DanShouzhu please also add Objects365 in English documents. Thx!

Thanks for your reminder, Objects365 has been added.

DanShouzhu avatar Feb 11 '23 11:02 DanShouzhu

Hi @DanShouzhu !First of all, we want to express our gratitude for your significant PR in the MMDet project. Your contribution is highly appreciated, and we are grateful for your efforts in helping improve this open-source project during your personal time. We believe that many developers will benefit from your PR.

We would also like to invite you to join our Special Interest Group (SIG) private channel on Discord, where you can share your experiences, ideas, and build connections with like-minded peers. To join the SIG channel, simply message moderator— OpenMMLab on Discord or briefly share your open-source contributions in the #introductions channel and we will assist you. Look forward to seeing you there! Join us :https://discord.gg/UjgXkPWNqA

If you have WeChat account,welcome to join our community on WeChat. You can add our assistant :openmmlabwx. Please add "mmsig + Github ID" as a remark when adding friends:) Thank you again for your contribution!❤

OpenMMLab-Assistant001 avatar Apr 04 '23 10:04 OpenMMLab-Assistant001