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.

Sign up for GitHub

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

Jump to bottom

[Docs] Update install guide and README #624

Merged
merged 6 commits into from
Jan 4, 2022
Merged

[Docs] Update install guide and README #624

merged 6 commits into from
Jan 4, 2022

Conversation

mzr1996
Copy link
Member

@mzr1996 mzr1996 commented Dec 31, 2021

Motivation

We have changed our development workflow and now we develop on the dev branch. Therefore we need to update our install guide.

Modification

  1. Update install guide.
  2. Update README, use readthedocs link preferentially. And add new repos.

Checklist

Before PR:

  • Pre-commit or other linting tools are used to fix the potential lint issues.
  • Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests.
  • The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, like docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with those projects, like MMDet or MMSeg.
  • CLA has been signed and all committers have signed the CLA in this PR.

@mzr1996 mzr1996 requested a review from Ezra-Yu December 31, 2021 09:08
Ezra-Yu
Ezra-Yu requested changes Dec 31, 2021
View reviewed changes
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@mzr1996 mzr1996 requested a review from Ezra-Yu January 4, 2022 03:05
Ezra-Yu
Ezra-Yu approved these changes Jan 4, 2022
View reviewed changes
Copy link
Collaborator

@Ezra-Yu Ezra-Yu left a comment

Choose a reason for hiding this comment

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

LGTM.

@mzr1996 mzr1996 merged commit 5232965 into open-mmlab:dev Jan 4, 2022
mzr1996 added a commit to mzr1996/mmpretrain that referenced this pull request Nov 24, 2022
@mzr1996
[Docs] Update install guide and README (open-mmlab#624)
3dcaf04 
* Update install guide

* Add new repos in README and use readthedocs link preferentially.

* Add MMRazor

* Improve README

* Imporve docs

* Imporve docs
@mzr1996 mzr1996 deleted the dev branch December 7, 2022 02:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Ezra-Yu Ezra-Yu Ezra-Yu approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mzr1996 @Ezra-Yu