Skip to content

Add HGNetV2 API documentation to hub_master.py #2141

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 4 commits into from
Aug 15, 2025

Conversation

laxmareddyp
Copy link
Contributor

No description provided.

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 @laxmareddyp, 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 introduces the necessary configuration to generate API documentation for the HGNetV2 family of models and layers within the keras_hub project. This change ensures that users can easily access detailed information about these components, improving their discoverability and usability by making their API reference available.

Highlights

  • Documentation Configuration: Added a new top-level entry for 'HGNetV2' in scripts/hub_master.py to define its documentation structure within the Keras Hub project.
  • API Generation: Configured the automatic generation of API documentation for several HGNetV2-related components, including keras_hub.layers.HGNetV2ImageConverter, keras_hub.models.HGNetV2Backbone, keras_hub.models.HGNetV2ImageClassifier, and keras_hub.models.HGNetV2ImageClassifierPreprocessor. This includes their from_preset methods and specific attributes like backbone and preprocessor for the classifier.
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 is currently in preview and 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 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 adds the API documentation configuration for the new HGNetV2 model. The changes are straightforward, but I've identified a minor maintainability issue regarding the alphabetical ordering of models in the configuration file to ensure consistency.

@laxmareddyp laxmareddyp marked this pull request as ready for review July 13, 2025 05:53
@laxmareddyp
Copy link
Contributor Author

/gemini review

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 adds API documentation for HGNetV2 models and layers. The changes are well-structured and follow the existing format. I've provided a couple of suggestions to improve consistency in the documentation titles for better clarity.

@laxmareddyp laxmareddyp marked this pull request as draft July 13, 2025 06:04
@laxmareddyp laxmareddyp marked this pull request as ready for review August 15, 2025 22:44
@sachinprasadhs sachinprasadhs merged commit 51ad99b into keras-team:master Aug 15, 2025
3 checks passed
@laxmareddyp laxmareddyp deleted the hgnetv2-api-doc branch August 17, 2025 05:13
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