Skip to content

Conversation

sallyjunjun
Copy link
Collaborator

@sallyjunjun sallyjunjun commented Aug 29, 2024

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

The information provided in InternEvo documentation is not the latest, and also some translation is not complete. We fix these problems in this pull request.

Modification

  • add data preparation instructions, including dataset of huggingface format.
  • fix missing English translation
  • add configuration instructions of saving and loading weight of huggingface format.
  • fix function import error
  • modify main page, remove lagacy performance information, add brief install and quick start instructions, add feature zoo, and change logo of InternEvo
  • add detailed instructions of train.py file in readthedocs and complete initialization instructions

BC-breaking (Optional)

Does the modification introduce changes that break the backward compatibility of the downstream repositories?
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

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.
  • CLA has been signed and all committers have signed the CLA in this PR.

@sallyjunjun sallyjunjun changed the title [WIP] improve documentation improve documentation Sep 2, 2024
@sunpengsdu sunpengsdu merged commit 673f1a2 into develop Sep 2, 2024
@sallyjunjun sallyjunjun deleted the improve-doc branch September 20, 2024 03:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants