Skip to content
New issue

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

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

Already on GitHub? # to your account

[Doc] refine some documents #2058

Merged
merged 10 commits into from
Nov 25, 2022
Merged

[Doc] refine some documents #2058

merged 10 commits into from
Nov 25, 2022

Conversation

ly015
Copy link
Member

@ly015 ly015 commented Nov 15, 2022

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily got feedback.
If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Please describe the motivation of this PR and the goal you want to achieve through this PR.

Review and refine the following documents:

  • get_started.md
  • contribution_guide.md
  • faq.md
  • migration.md
  • switch_language.md

Modification

Please briefly describe what modification is made in this PR.

BC-breaking (Optional)

Does the modification introduces changes that break the back-compatibility of this repo?
If so, please describe how it breaks the compatibility and how users should modify their codes 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 should be used to fix the potential lint issues.
  2. The modification should be covered by complete unit tests. If not, please add more unit tests 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 should be modified accordingly, like docstring or example tutorials.

@ly015 ly015 marked this pull request as draft November 15, 2022 02:52
@ly015 ly015 marked this pull request as ready for review November 15, 2022 09:47
@ly015 ly015 requested review from cir7 and Dai-Wenxun November 15, 2022 09:47
@ly015
Copy link
Member Author

ly015 commented Nov 15, 2022

@Dai-Wenxun Could you please help update faq.md which contains outdated contents?

@codecov
Copy link

codecov bot commented Nov 15, 2022

Codecov Report

Base: 76.00% // Head: 76.00% // Decreases project coverage by -0.00% ⚠️

Coverage data is based on head (49c8a4e) compared to base (d131a87).
Patch has no changes to coverable lines.

Additional details and impacted files
@@             Coverage Diff             @@
##           dev-1.x    #2058      +/-   ##
===========================================
- Coverage    76.00%   76.00%   -0.01%     
===========================================
  Files          137      137              
  Lines         9924     9918       -6     
  Branches      1627     1626       -1     
===========================================
- Hits          7543     7538       -5     
  Misses        2029     2029              
+ Partials       352      351       -1     
Flag Coverage Δ
unittests 76.00% <ø> (-0.01%) ⬇️

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

Impacted Files Coverage Δ
mmaction/models/recognizers/base.py 60.71% <0.00%> (-2.21%) ⬇️
mmaction/models/heads/base.py 77.64% <0.00%> (-0.26%) ⬇️
mmaction/datasets/transforms/formatting.py 83.49% <0.00%> (ø)
mmaction/models/heads/tpn_head.py 85.71% <0.00%> (+2.38%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@ly015
Copy link
Member Author

ly015 commented Nov 22, 2022

@cir7 Add docker part to get_started.md

@Dai-Wenxun Dai-Wenxun mentioned this pull request Nov 23, 2022
@ly015 ly015 merged commit 5afd831 into open-mmlab:dev-1.x Nov 25, 2022
ly015 added a commit that referenced this pull request Jan 10, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants