-
Notifications
You must be signed in to change notification settings - Fork 416
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.
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
Docs/guide #1183
Docs/guide #1183
Conversation
2. Make guide documentation and file structure consistent with examples/guide. 3. Add helpful comments in guide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some small corrections, see my comments bellow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for the addition of many details. I have a high number of comments but most of them are about typos
Quick feedback re formatting (haven't read the content in details yet). I recommend you format the text using something like prettier if you have a VS/Neovim plug-in. We have a configuration for prettier: https://github.com/tracel-ai/burn/blob/main/burn-book/.prettierrc.json (or you can define yours) This helps formatting tables and wrapping markdown text. |
2. Fix formatting 3. remove dead link
Many thanks @nathanielsimard, @louisfd, and @antimora for the suggestions. Incorporated in the latest commit. Let me know if it's good to go. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice, all conversations were well resolved. I spotted two minor typos but approving in advance.
Thank again for the review. Made the minor fixes suggested. Merging now! |
Checklist
run-checks all
script has been executed.Related Issues/PRs
#1103 : Better documentation of Guide example.
#1153: Improve Tensor introduction
#1154: Improve Dataset transform guide
Changes
Corresponding to each issue, here are the changes in this PR:
#1103 : The changes suggested bridge the gap between the example code provided in examples/guide vs what is written in guide. The documentation currently lacked the partitioning of code into model, data, training files similar to the example code. This sometimes made it hard to follow if for eg someone is copy-pasting code from there. Fixed these issues and added helpful comments with reference to original example.
#1153
#1154