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.

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

Merged
merged 6 commits into from
Jan 30, 2024
Merged

Docs/guide #1183

merged 6 commits into from
Jan 30, 2024

Conversation

ashdtu
Copy link
Contributor

@ashdtu ashdtu commented Jan 26, 2024

Checklist

  • Confirmed that run-checks all script has been executed.
  • Made sure the book is up to date with changes in this PR.

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

  • Added introduction of Tensor with rank, similarity/diff for people coming from PyTorch.
  • Initialization from data, floats api. .convert() , elem etc.
  • Underline importance of ownership and cloning with example.
  • No stateful operations : TODO (discuss)

#1154

  • Added introduction of dataset transform with example usages.
  • Batcher omitted as already present in current guide in mnist tutorial and other concepts covered by Rust introduction commit.

Copy link
Member

@nathanielsimard nathanielsimard left a 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.

burn-book/src/building-blocks/dataset.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/dataset.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
Copy link
Member

@louisfd louisfd left a 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

burn-book/src/basic-workflow/README.md Outdated Show resolved Hide resolved
burn-book/src/basic-workflow/README.md Outdated Show resolved Hide resolved
burn-book/src/basic-workflow/backend.md Outdated Show resolved Hide resolved
burn-book/src/basic-workflow/backend.md Outdated Show resolved Hide resolved
burn-book/src/basic-workflow/backend.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
@antimora
Copy link
Collaborator

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
@ashdtu
Copy link
Contributor Author

ashdtu commented Jan 29, 2024

Many thanks @nathanielsimard, @louisfd, and @antimora for the suggestions. Incorporated in the latest commit. Let me know if it's good to go.

burn-book/src/basic-workflow/model.md Outdated Show resolved Hide resolved
Copy link
Member

@louisfd louisfd left a 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.

burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
burn-book/src/building-blocks/tensor.md Outdated Show resolved Hide resolved
@ashdtu
Copy link
Contributor Author

ashdtu commented Jan 30, 2024

Thank again for the review. Made the minor fixes suggested. Merging now!

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.

4 participants