Skip to content

Fix: format consistency issue#2420

Open
HsienChing wants to merge 1 commit intotensorflow:masterfrom
HsienChing:patch-1
Open

Fix: format consistency issue#2420
HsienChing wants to merge 1 commit intotensorflow:masterfrom
HsienChing:patch-1

Conversation

@HsienChing
Copy link
Copy Markdown

Format consistency issue

Position: "Computing gradients" section

Link: https://www.tensorflow.org/guide/autodiff#computing_gradients

Condition: There is a format issue in the "forward pass" and "backward pass", as shown in the red rectangles in the following image.

Readers might confuse the whole termiology.

Suggestion: It seems that "forward pass" and "backward pass" are more reasonable.

REF: https://github.com/HsienChing/ML_DL_project_State_Estimation_of_Li-ion_Batteries/blob/main/other/Issues_in_TensorFlow_official_doc_Introduction_to_gradients_and_automatic_differentiation.ipynb

Format consistency issue

**Position:** "Computing gradients" section

**Link:** https://www.tensorflow.org/guide/autodiff#computing_gradients

**Condition:** There is a format issue in the "*forward* pass" and "*backward pass*", as shown in the red rectangles in the following image.

Readers might confuse the whole termiology.

**Suggestion:** It seems that "*forward pass*" and "*backward pass*" are more reasonable.

REF: https://github.com/HsienChing/ML_DL_project_State_Estimation_of_Li-ion_Batteries/blob/main/other/Issues_in_TensorFlow_official_doc_Introduction_to_gradients_and_automatic_differentiation.ipynb
@HsienChing HsienChing requested a review from a team as a code owner April 8, 2026 08:59
@google-cla
Copy link
Copy Markdown

google-cla bot commented Apr 8, 2026

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

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

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.

1 participant