Added documentation for configs/common (lsj, ms, ssj explanation) Issue#9581#12435
Open
SprihaPodder wants to merge 1 commit intoopen-mmlab:mainfrom
Open
Added documentation for configs/common (lsj, ms, ssj explanation) Issue#9581#12435SprihaPodder wants to merge 1 commit intoopen-mmlab:mainfrom
SprihaPodder wants to merge 1 commit intoopen-mmlab:mainfrom
Conversation
|
|
SprihaPodder
changed the title
Author
|
Hi, thank you for reviewing. This PR focuses on improving documentation for config files as discussed in issue #9581. Please let me know if any modifications are needed to pass checks or improve the contribution. Happy to update accordingly! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The issue (#9581) highlighted that documentation for configuration files, especially in configs/common, is unclear and scattered. This can make it difficult for new users to understand concepts like lsj, ms, and ssj.
Modification
BC-breaking (Optional)
No breaking changes. This PR only improves documentation.
Use cases (Optional)
This helps new users better understand configuration files and training strategies, improving usability and onboarding experience.
Checklist
The documentation has been modified accordingly