Skip to content

Conversation

@jlin27
Copy link

@jlin27 jlin27 commented Jul 15, 2020

Made some syntax edits because original headings were not rendering properly and breaking the build:

  • Removed the lines of pound sign (#) delimiters under text because when placed under text, it renders them all as headers
  • Add lines of pound delimiters above certain blocks of text to force them to show up as plain text between the code rather than comments with the code
  • Added code syntax (e.g.compare_weights)

Suggestions:

Fixes:

  • Currently the tutorial references images in /_static/img/ but they are placed in /_static/. Make sure these match up.

Made some syntax edits because original headings were not rendering properly and breaking the build:
- Removed the lines of pound sign (#) delimiters under text because when placed under text, it renders them all as headers
- Add lines of pound delimiters above certain blocks of text to force them to show up as plain text between the code rather than comments with the code
- Added code syntax  (e.g.``compare_weights``)

Suggestions: 
- Link to code or documentation (for example in the beginning when referencing new code or new concepts)
- Add a conclusion section with links to references or learn more at the end
    - Examples:
https://pytorch.org/tutorials/intermediate/dynamic_quantization_bert_tutorial.html#conclusion

Fixes:
- Currently the tutorial references images in `/_static/img/` but they are placed in `/_static/`. Make sure these match up.
@jlin27
Copy link
Author

jlin27 commented Jul 15, 2020

@hx89
Copy link
Owner

hx89 commented Jul 15, 2020

Thanks @jlin27 for your feedback and revisions, it looks much better now!

Just wonder how should I proceed to incorporate your revisions and suggestions, should I merge your PR to my master and continue editing on top of it?

And I want the tutorial to print out the outputs of each cell for demonstration purpose, what should I do to enable that?

@hx89 hx89 merged commit 1f5d002 into hx89:master Jul 16, 2020
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