-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add DeiT API usage documentation #2162
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
base: master
Are you sure you want to change the base?
Conversation
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.
Summary of Changes
Hello @sachinprasadhs, 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 enhancing the project's documentation by integrating the DeiT (Data-efficient Image Transformers) API components into the automated documentation generation system. The changes primarily involve updating the documentation configuration to ensure that key DeiT models, layers, and their associated methods and properties are properly documented and accessible. This will improve the discoverability and usability of the DeiT API for developers.
Highlights
- DeiTImageConverter Documentation: This pull request introduces the necessary configuration to automatically generate API documentation for the
DeiTImageConverter
layer, including itsfrom_preset
method. - DeiTBackbone Model Documentation: Configuration has been added to generate documentation for the
DeiTBackbone
model, covering its main class and thefrom_preset
method. - DeiTImageClassifier Model Documentation: The changes include setting up documentation generation for the
DeiTImageClassifier
model, itsfrom_preset
method, and itsbackbone
andpreprocessor
properties. - DeiTImageClassifierPreprocessor Documentation: Documentation will now be generated for the
DeiTImageClassifierPreprocessor
layer, including itsfrom_preset
method and theimage_converter
property.
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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
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
-
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. ↩
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.
Code Review
This pull request adds the necessary configuration to scripts/hub_master.py
to generate API documentation for the DeiT (Data-efficient image Transformers) models. The changes are well-structured and consistent with existing model documentation entries in the file. The new entry for DeiT is placed in correct alphabetical order and includes documentation for DeiTImageConverter
, DeiTBackbone
, DeiTImageClassifier
, and DeiTImageClassifierPreprocessor
. The code looks good and I have no suggestions for improvement.
No description provided.