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

Updated few links with direct URLs in data_performance.ipynb #2227

Merged
merged 11 commits into from
Sep 27, 2023

Conversation

RenuPatelGoogle
Copy link
Contributor

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.

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.
@RenuPatelGoogle RenuPatelGoogle requested a review from a team as a code owner June 1, 2023 07:22
@github-actions
Copy link

github-actions bot commented Jun 1, 2023

Preview

Preview and run these notebook edits with Google Colab: Rendered notebook diffs available on ReviewNB.com.

Format and style

Use 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/docs

$ python3 -m tensorflow_docs.tools.nbfmt notebook.ipynb
$ python3 -m tensorflow_docs.tools.nblint --arg=repo:tensorflow/docs notebook.ipynb
If commits are added to the pull request, synchronize your local branch: git pull origin patch-26

Copy link
Member

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

site/en/guide/data_performance.ipynb Outdated Show resolved Hide resolved
Reverted the changes as mentioned.
markmcd
markmcd previously approved these changes Jun 1, 2023
@github-actions github-actions bot added the lgtm Community-added approval label Jun 1, 2023
@markmcd
Copy link
Member

markmcd commented Jun 1, 2023

Your change LG, but can you fix the failing nbfmt check.

Details are in the check and in the comment from @github-actions.

Preview

Preview and run these notebook edits with Google Colab:

Rendered notebook diffs available on ReviewNB.com.

Format and style

Use 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/docs

$ python3 -m tensorflow_docs.tools.nbfmt notebook.ipynb

$ python3 -m tensorflow_docs.tools.nblint --arg=repo:tensorflow/docs notebook.ipynb
If commits are added to the pull request, synchronize your local branch: git pull origin patch-26

@8bitmp3
Copy link
Contributor

8bitmp3 commented Jul 18, 2023

Formatted the notebook. Thank you @markmcd @RenuPatelGoogle

@8bitmp3 8bitmp3 added the ready to pull Start merge process label Jul 18, 2023
8bitmp3
8bitmp3 previously approved these changes Jul 18, 2023
"* [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",
Copy link
Member

@MarkDaoust MarkDaoust Jul 19, 2023

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.

Copy link
Contributor Author

@RenuPatelGoogle RenuPatelGoogle Aug 4, 2023

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.

Copy link
Member

@MarkDaoust MarkDaoust Aug 4, 2023

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.

Copy link
Contributor Author

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

Copy link
Member

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">

Copy link
Contributor Author

@RenuPatelGoogle RenuPatelGoogle Sep 26, 2023

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.

@gbaned
Copy link
Contributor

gbaned commented Jul 31, 2023

Hi @RenuPatelGoogle Can you please check @MarkDaoust's comments ? Thank you!

@gbaned
Copy link
Contributor

gbaned commented Sep 26, 2023

Hi @RenuPatelGoogle Any update on this PR? Please. Thank you!

Updated the file as mentioned by MarkDaoust.
@RenuPatelGoogle
Copy link
Contributor Author

RenuPatelGoogle commented Sep 26, 2023

Update data_performance.ipynb

@gbaned, Yes, I have added the changes. Waiting for review.

@github-actions
Copy link

Preview

Preview and run these notebook edits with Google Colab: Rendered notebook diffs available on ReviewNB.com.

Format and style

Use 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/docs

$ python3 -m tensorflow_docs.tools.nbfmt notebook.ipynb
$ python3 -m tensorflow_docs.tools.nblint --arg=repo:tensorflow/docs notebook.ipynb
If commits are added to the pull request, synchronize your local branch: git pull origin patch-26

@MarkDaoust
Copy link
Member

Oops, It looks like on the latest version of the change all the added aren't properly intergrated into the json.

<a name="name"> should be "<a name=\"name\">\n",

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.

Copy link
Member

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

@8bitmp3 8bitmp3 added ready to pull Start merge process and removed ready to pull Start merge process labels Sep 27, 2023
@MarkDaoust
Copy link
Member

Thanks!

@copybara-service copybara-service bot merged commit 35c5f42 into tensorflow:master Sep 27, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Community-added approval ready to pull Start merge process
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants