-
Notifications
You must be signed in to change notification settings - Fork 5.3k
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
Updated few links with direct URLs in data_performance.ipynb #2227
Updated few links with direct URLs in data_performance.ipynb #2227
Conversation
I have updated the links for routing directly to the mentioned section which was not working earlier. Also changed the code format of 2 words.
PreviewPreview and run these notebook edits with Google Colab: Rendered notebook diffs available on ReviewNB.com.Format and styleUse the TensorFlow docs notebook tools to format for consistent source diffs and lint for style:$ python3 -m pip install -U --user git+https://github.com/tensorflow/docsIf commits are added to the pull request, synchronize your local branch: git pull origin patch-26
|
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 for the PR! Your link updates LGTM - if you can revert the steps
change we can merge this.
Reverted the changes as mentioned.
Your change LG, but can you fix the failing nbfmt check. Details are in the check and in the comment from @github-actions.
|
Formatted the notebook. Thank you @markmcd @RenuPatelGoogle |
"* [Use the `cache` transformation](#Caching) to cache data in memory during the first epoch\n", | ||
"* [Vectorize user-defined functions](#Map-and-batch) passed in to the `map` transformation\n", | ||
"* [Reduce memory usage](#Reducing-memory-footprint) when applying the `interleave`, `prefetch`, and `shuffle` transformations" | ||
"* [Use the `prefetch` transformation](#prefetching) to overlap the work of a producer and consumer\n", |
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.
Automated anchor links for headings are generated differently on different systems, I don't remember the formatting for colab vs. github vs. tensorflow.org. It's best to include an <a name="">
at the target location so that it unambiguously works in all contexts.
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.
Hi @MarkDaoust ,I don't have idea about the target location. In this case, Can I mention full URL of the working link? or you can suggest.
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.
Sorry, my last comment didn't render correctly.
#Reducing-memory-footprint
is trying to point to ### Reduce memory footprint
heading.
Please add something like <a name="reduce-memory">
at each heading you're linking to, and update the link to match (like [link](#reduce-memory)
). This is a good idea because each website normalizes the titles to anchors differently.
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.
You mean like below changes for the line - Use the prefetch
transformation to overlap the work of a producer and consumer
Use the [<a name="prefetch">](#prefetching)
transformation
or
Use the [prefetch](https://www.tensorflow.org/guide/data_performance#prefetching)
transformation
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.
No. For [Reduce memory usage](#Reducing-memory-footprint)
go down to the section you're trying to link to and add the <a>
there:
### Reduce memory footprint
<a name="reduce_memory_footprint">
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.
@MarkDaoust, Sorry for the delay. I have updated the file as you suggested. Please verify it once if it is same as you described. Thank you.
Hi @RenuPatelGoogle Can you please check @MarkDaoust's comments ? Thank you! |
Hi @RenuPatelGoogle Any update on this PR? Please. Thank you! |
Updated the file as mentioned by MarkDaoust.
@gbaned, Yes, I have added the changes. Waiting for review. |
Oops, It looks like on the latest version of the change all the added aren't properly intergrated into the json.
It's best to just make the edits in a notebook editor (colab or jupyter) or at least check that they work in github with the "view file" button. |
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.
See my last comment.
Thanks! |
I have updated the links for routing directly to the mentioned section which was not working earlier. Also changed the code format of 2 words.