Skip to content

Fix a few typos in comments #21525

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

Merged
merged 1 commit into from
Jul 28, 2025
Merged

Fix a few typos in comments #21525

merged 1 commit into from
Jul 28, 2025

Conversation

bzamecnik
Copy link
Contributor

Credits: PyCharm spellchecker

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @bzamecnik, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the overall quality and clarity of the Keras codebase by fixing a collection of typos found in comments and documentation strings. The changes are purely textual and do not alter any functional behavior of the code, but rather make the explanations and internal notes more accurate and professional.

Highlights

  • Comment Clarity: Corrected various spelling errors and grammatical mistakes within code comments and docstrings across multiple Keras modules, enhancing readability and accuracy.
  • Consistency in Terminology: Standardized terms like 'traceable' (from 'tracable'), 'flash attention' (from 'flase attention'), and 'uprank' (from 'unprank') for improved consistency.
  • Metric Calculation Explanations: Fixed typos in comments explaining complex metric calculations, such as 'examples' (from 'exampless'), 'overestimation' (from 'overstimation'), and 'scaling_factor' (from 'scaling_facor').
  • Internal Code Documentation: Addressed minor typos in internal testing utilities, functional model descriptions, and backend-specific notes, ensuring clearer internal documentation.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request fixes several typos in comments across the codebase. The changes are mostly correct. I've pointed out one instance where a typo fix seems to have incorrectly changed the meaning of a comment in a test file.

@codecov-commenter
Copy link

codecov-commenter commented Jul 28, 2025

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 82.72%. Comparing base (8bf6a58) to head (adc3163).

Files with missing lines Patch % Lines
keras/src/tree/optree_impl.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master   #21525   +/-   ##
=======================================
  Coverage   82.72%   82.72%           
=======================================
  Files         567      567           
  Lines       56245    56245           
  Branches     8790     8790           
=======================================
  Hits        46527    46527           
  Misses       7561     7561           
  Partials     2157     2157           
Flag Coverage Δ
keras 82.52% <0.00%> (ø)
keras-jax 63.93% <0.00%> (ø)
keras-numpy 58.42% <0.00%> (ø)
keras-openvino 34.57% <0.00%> (ø)
keras-tensorflow 64.35% <0.00%> (ø)
keras-torch 63.98% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@google-ml-butler google-ml-butler bot added kokoro:force-run ready to pull Ready to be merged into the codebase labels Jul 28, 2025
@fchollet fchollet merged commit 6bc6203 into keras-team:master Jul 28, 2025
8 checks passed
@bzamecnik bzamecnik deleted the fix-typos branch July 31, 2025 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kokoro:force-run ready to pull Ready to be merged into the codebase size:S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants