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

DanShouzhu · 2023-01-05T16:39:53Z

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

Pre-commit or other linting tools are used to fix the potential lint issues.
The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
The documentation has been modified accordingly, like docstring or example tutorials.

CLAassistant · 2023-01-05T16:39:58Z

All committers have signed the CLA.

ZwwWayne · 2023-01-06T07:49:04Z

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

docs/zh_cn/user_guides/finetune.md

docs/zh_cn/user_guides/inference.md

docs/zh_cn/user_guides/finetune.md

DanShouzhu · 2023-01-07T13:34:11Z

@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 · 2023-01-07T13:40:45Z

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

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.

docs/zh_cn/user_guides/finetune.md

DanShouzhu

Changes were accepted.

BIGWangYuDong · 2023-01-13T08:36:39Z

seems the lint has failed, please fix the lint

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

DanShouzhu · 2023-01-15T02:29:34Z

@BIGWangYuDong

All checks have passed after using pre-commit.

Thank you so much!

docs/zh_cn/user_guides/inference.md

docs/zh_cn/user_guides/finetune.md

ZwwWayne · 2023-02-02T03:10:07Z

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

DanShouzhu · 2023-02-05T10:16:44Z

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

docs/zh_cn/user_guides/finetune.md

ZwwWayne · 2023-02-06T02:30:21Z

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

BIGWangYuDong · 2023-02-08T01:55:00Z

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

BIGWangYuDong · 2023-02-08T01:55:23Z

This PR can be merged after fixing these small issues

RangeKing · 2023-02-09T09:17:50Z

docs/zh_cn/user_guides/inference.md


-asyncio.run(main())
+jupyter notebook 上的演示样例在 [demo/inference_demo.ipynb](../../../demo/inference_demo.ipynb) 。


Suggested change

jupyter notebook 上的演示样例在 [demo/inference_demo.ipynb](../../../demo/inference_demo.ipynb) 。

jupyter notebook 上的演示样例在 [demo/inference_demo.ipynb](https://github.com/open-mmlab/mmdetection/blob/3.x/demo/inference_demo.ipynb) 。

Do not use relative links except for .md links. Otherwise readthedocs won't render correctly.

Thanks for your suggestions. And four relative paths in this file have been changed to static links.

But one thing that needs to be mentioned here is:
Relative links are used in the corresponding English version doc.

Thanks again.

@DanShouzhu, Relative links in the corresponding English doc should also be modified.

RangeKing · 2023-02-09T09:18:22Z

docs/zh_cn/user_guides/inference.md


 ## 演示样例

-我们还提供了三个演示脚本，它们是使用高层编程接口实现的。 [源码在此](https://github.com/open-mmlab/mmdetection/tree/master/demo) 。
+我们还提供了三个演示脚本，它们是使用高层编程接口实现的。 [源码在此](../../../demo) 。


Suggested change

我们还提供了三个演示脚本，它们是使用高层编程接口实现的。 [源码在此](../../../demo) 。

我们还提供了三个演示脚本，它们是使用高层编程接口实现的。 [源码在此](https://github.com/open-mmlab/mmdetection/tree/3.x/demo) 。

DanShouzhu · 2023-02-11T11:44:25Z

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

Thanks for your reminder, Objects365 has been added.

RangeKing

This PR can be merged after modifying two relative links to absolute links in the English doc.

RangeKing · 2023-02-17T01:17:34Z

docs/en/user_guides/finetune.md

@@ -56,7 +56,7 @@ model = dict(

 ## Modify dataset

-The users may also need to prepare the dataset and write the configs about dataset, refer to [Customize Datasets](../advanced_guides/customize_dataset.md) for more detail. MMDetection V3.0 already supports VOC, WIDERFACE, COCO, LIVS, OpenImages, DeepFashion and Cityscapes Dataset.
+The users may also need to prepare the dataset and write the configs about dataset, refer to [Customize Datasets](../advanced_guides/customize_dataset.md) for more detail. MMDetection V3.0 already supports VOC, WIDERFACE, COCO, LIVS, OpenImages, DeepFashion, Objects365 and Cityscapes Dataset.


Suggested change

The users may also need to prepare the dataset and write the configs about dataset, refer to [Customize Datasets](../advanced_guides/customize_dataset.md) for more detail. MMDetection V3.0 already supports VOC, WIDERFACE, COCO, LIVS, OpenImages, DeepFashion, Objects365 and Cityscapes Dataset.

The users may also need to prepare the dataset and write the configs about dataset, refer to [Customize Datasets](../advanced_guides/customize_dataset.md) for more detail. MMDetection V3.0 already supports VOC, WIDERFACE, COCO, LIVS, OpenImages, DeepFashion, Objects365, and Cityscapes Dataset.

Hi there, thanks for your clarification.
Those relative links have been fixed, and the comma also has been added.
Could you take a quick look at the code?

…ke in inference.md in english.

Co-authored-by: Yue Zhou <592267829@qq.com>

Signed-off-by: cecil_dan <danshouzhu@outlook.com>

fix mistakes in comments.

fixed a mistake in the comments.

RangeKing

LGTM

OpenMMLab-Assistant001 · 2023-04-04T10:44:30Z

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！❤

Signed-off-by: cecil_dan <danshouzhu@outlook.com> Co-authored-by: Yue Zhou <592267829@qq.com>

mm-assistant bot assigned RangiLyu Jan 5, 2023

ZwwWayne requested a review from zytx121 January 6, 2023 07:48

ZwwWayne added this to the 3.0.0rc6 milestone Jan 6, 2023

zytx121 reviewed Jan 6, 2023

View reviewed changes

ZwwWayne requested a review from zytx121 January 9, 2023 04:46

BIGWangYuDong reviewed Jan 9, 2023

View reviewed changes

docs/zh_cn/user_guides/finetune.md Outdated Show resolved Hide resolved

DanShouzhu commented Jan 13, 2023

View reviewed changes

DanShouzhu force-pushed the update_docs_part4 branch from ce704b7 to e00b311 Compare January 15, 2023 02:20

ZwwWayne requested a review from BIGWangYuDong January 28, 2023 06:54

BIGWangYuDong reviewed Jan 29, 2023

View reviewed changes

docs/zh_cn/user_guides/inference.md Outdated Show resolved Hide resolved

docs/zh_cn/user_guides/finetune.md Outdated Show resolved Hide resolved

ZwwWayne requested a review from triple-Mu January 30, 2023 05:11

DanShouzhu force-pushed the update_docs_part4 branch from 51df2d8 to f7fb44a Compare February 5, 2023 09:59

ZwwWayne reviewed Feb 6, 2023

View reviewed changes

docs/zh_cn/user_guides/finetune.md Outdated Show resolved Hide resolved

docs/zh_cn/user_guides/finetune.md Outdated Show resolved Hide resolved

RangeKing reviewed Feb 9, 2023

View reviewed changes

DanShouzhu force-pushed the update_docs_part4 branch from 02acda8 to 88e5ea0 Compare February 11, 2023 08:35

ZwwWayne requested a review from RangeKing February 16, 2023 13:10

RangeKing reviewed Feb 17, 2023

View reviewed changes

update docs: "finetune.md, inference.md" in chinese and fixed a mista…

60096a4

…ke in inference.md in english.

DanShouzhu and others added 9 commits February 18, 2023 09:52

Apply suggestions from code review

4e87467

Co-authored-by: Yue Zhou <592267829@qq.com>

Update finetune.md

0597c7d

Update finetune.md

9d720c7

trim whitspace in inference.md

a3d03e4

Signed-off-by: cecil_dan <danshouzhu@outlook.com>

Update inference.md

bb1d3bd

fix mistakes in comments.

Update inference.md

50f9391

fixed a mistake in the comments.

update sample code.

ed45804

Update finetune.md

7c11185

Objects365 is added, and made some updates after rebasing on dev-3.x, .

48827d7

DanShouzhu force-pushed the update_docs_part4 branch from 88e5ea0 to 9108fc1 Compare February 18, 2023 01:53

replace relative links with absoulute links in english version doc.

9935c71

DanShouzhu force-pushed the update_docs_part4 branch from 9108fc1 to 9935c71 Compare February 18, 2023 03:22

RangeKing approved these changes Feb 18, 2023

View reviewed changes

ZwwWayne approved these changes Feb 23, 2023

View reviewed changes

ZwwWayne merged commit 2341347 into open-mmlab:dev-3.x Feb 23, 2023

yumion pushed a commit to yumion/mmdetection that referenced this pull request Jan 31, 2024

[Doc]: update user guide: "finetune.md, inference.md" (open-mmlab#9578)

84cf165

Signed-off-by: cecil_dan <danshouzhu@outlook.com> Co-authored-by: Yue Zhou <592267829@qq.com>


		asyncio.run(main())
		jupyter notebook 上的演示样例在 [demo/inference_demo.ipynb](../../../demo/inference_demo.ipynb) 。

	我们还提供了三个演示脚本，它们是使用高层编程接口实现的。 [源码在此](../../../demo) 。
	我们还提供了三个演示脚本，它们是使用高层编程接口实现的。 [源码在此](https://github.com/open-mmlab/mmdetection/tree/3.x/demo) 。

	The users may also need to prepare the dataset and write the configs about dataset, refer to [Customize Datasets](../advanced_guides/customize_dataset.md) for more detail. MMDetection V3.0 already supports VOC, WIDERFACE, COCO, LIVS, OpenImages, DeepFashion, Objects365 and Cityscapes Dataset.
	The users may also need to prepare the dataset and write the configs about dataset, refer to [Customize Datasets](../advanced_guides/customize_dataset.md) for more detail. MMDetection V3.0 already supports VOC, WIDERFACE, COCO, LIVS, OpenImages, DeepFashion, Objects365, and Cityscapes Dataset.

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

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

Uh oh!

Conversation

DanShouzhu commented Jan 5, 2023

Motivation

Modification

BC-breaking (Optional)

Use cases (Optional)

Checklist

Uh oh!

CLAassistant commented Jan 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ZwwWayne commented Jan 6, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DanShouzhu commented Jan 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DanShouzhu commented Jan 7, 2023

Uh oh!

Uh oh!

DanShouzhu left a comment

Choose a reason for hiding this comment

Uh oh!

BIGWangYuDong commented Jan 13, 2023

Uh oh!

DanShouzhu commented Jan 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ZwwWayne commented Feb 2, 2023

Uh oh!

DanShouzhu commented Feb 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ZwwWayne commented Feb 6, 2023

Uh oh!

BIGWangYuDong commented Feb 8, 2023

Uh oh!

BIGWangYuDong commented Feb 8, 2023

Uh oh!

RangeKing Feb 9, 2023

Choose a reason for hiding this comment

Uh oh!

DanShouzhu Feb 11, 2023

Choose a reason for hiding this comment

Uh oh!

RangeKing Feb 17, 2023

Choose a reason for hiding this comment

Uh oh!

RangeKing Feb 9, 2023

Choose a reason for hiding this comment

Uh oh!

DanShouzhu commented Feb 11, 2023

Uh oh!

RangeKing left a comment

Choose a reason for hiding this comment

Uh oh!

RangeKing Feb 17, 2023

Choose a reason for hiding this comment

Uh oh!

DanShouzhu Feb 18, 2023

Choose a reason for hiding this comment

Uh oh!

RangeKing left a comment

Choose a reason for hiding this comment

Uh oh!

OpenMMLab-Assistant001 commented Apr 4, 2023

Uh oh!

Uh oh!

CLAassistant commented Jan 5, 2023 •

edited

Loading

DanShouzhu commented Jan 7, 2023 •

edited

Loading

DanShouzhu commented Jan 15, 2023 •

edited

Loading

DanShouzhu commented Feb 5, 2023 •

edited

Loading