-
Notifications
You must be signed in to change notification settings - Fork 108
Readme update #125
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: main
Are you sure you want to change the base?
Readme update #125
Conversation
Provide more detail for each samples and add them in a table.
Summary of ChangesHello @lethargicpanda, 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 significantly improves the Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
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 updates the main README.md to provide a more visually appealing and descriptive list of the available samples, using a table with screenshots. The changes are a good improvement, but I've found a few small issues like a broken link, a typo, a grammatical error, and incorrect alt text. I've also suggested a way to clean up the Markdown for better maintainability.
ai-catalog/README.md
Outdated
| | | | | ||
| | <img src="samples/gemini-chatbot/gemini_chatbot.png" width="150" alt="Gemini Chatbot sample"> | ✨🗣️ **Gemini Chatbot**:<br>A chatbot app using the Gemini Flash model. You can tweak the [system instructions](https://firebase.google.com/docs/ai-logic/system-instructions) in the model configuration to change the tone or the persona of the model.<br><br><br><br> **[> Browse code](samples/gemini-chatbot)**<br><br> | | ||
| | | | | ||
| | <img src="samples/gemini-multimodal/gemini_multimodal.png" width="150" alt="Gemini Multimodal sample"> | ✨📸 **Gemini Multimodal**:<br>A sample leveraging the [multimodal capabilities]([url](https://developer.android.com/ai/gemini/developer-api#generate-text-from-media) of the Gemini Flash model (in this case text and image-to-text) to let you prompt the model with an image.<br><br><br><br> **[> Browse code](samples/gemini-multimodal)**<br><br> | |
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.
The link for 'multimodal capabilities' is broken due to incorrect Markdown syntax. It contains a nested, invalid [url](...) structure.
| | <img src="samples/gemini-multimodal/gemini_multimodal.png" width="150" alt="Gemini Multimodal sample"> | ✨📸 **Gemini Multimodal**:<br>A sample leveraging the [multimodal capabilities]([url](https://developer.android.com/ai/gemini/developer-api#generate-text-from-media) of the Gemini Flash model (in this case text and image-to-text) to let you prompt the model with an image.<br><br><br><br> **[> Browse code](samples/gemini-multimodal)**<br><br> | | |
| | <img src="samples/gemini-multimodal/gemini_multimodal.png" width="150" alt="Gemini Multimodal sample"> | ✨📸 **Gemini Multimodal**:<br>A sample leveraging the [multimodal capabilities](https://developer.android.com/ai/gemini/developer-api#generate-text-from-media) of the Gemini Flash model (in this case text and image-to-text) to let you prompt the model with an image.<br><br><br><br> **[> Browse code](samples/gemini-multimodal)**<br><br> | |
| | Samples | | | ||
| |:----------------------------------------------------------------------------------------------------------------------------------|-----------| | ||
| | <img src="samples/gemini-image-chat/android_nano_banana.png" width="150" alt="Gemini Image Chat sample"> | ✨🖼️🍌 **Gemini Image Chat**:<br>A chatbot app using the new [Gemini 2.5 Flash Image model](https://developers.googleblog.com/en/introducing-gemini-2-5-flash-image/) (a.k.a. "NanoBanana") enabling image generation and iterations via conversation with the Gemini model. Ask the model to generate an image and ask for tweaks in the chat.<br><br><br><br> **[> Browse code](samples/gemini-image-chat)**<br><br> | | ||
| | | | |
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.
This empty table row, which contains only spaces, is used for adding vertical separation. This pattern is repeated for each sample, which adds unnecessary lines and clutter to the Markdown source, making it harder to maintain. Consider removing these spacer rows and instead add an extra <br> tag within the description cell above if more spacing is desired.
ai-catalog/README.md
Outdated
| | | | | ||
| | <img src="samples/gemini-multimodal/gemini_multimodal.png" width="150" alt="Gemini Multimodal sample"> | ✨📸 **Gemini Multimodal**:<br>A sample leveraging the [multimodal capabilities]([url](https://developer.android.com/ai/gemini/developer-api#generate-text-from-media) of the Gemini Flash model (in this case text and image-to-text) to let you prompt the model with an image.<br><br><br><br> **[> Browse code](samples/gemini-multimodal)**<br><br> | | ||
| | | | | ||
| | <img src="samples/genai-summarization/nano_summarization.png" width="150" alt="Gemini Nano summarization sample"> | ✨📱📰 **On-device Summarization**: <br>A sample letting you summarizing text on-device using Gemini Nano via the [GenAI Summarization API](https://developers.google.com/ml-kit/genai/summarization/android).<br><br><br><br> **[> Browse code](samples/genai-summarization)**<br><br> | |
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.
There's a small grammatical error in the description. 'summarizing' should be 'summarize' to be grammatically correct in this context.
| | <img src="samples/genai-summarization/nano_summarization.png" width="150" alt="Gemini Nano summarization sample"> | ✨📱📰 **On-device Summarization**: <br>A sample letting you summarizing text on-device using Gemini Nano via the [GenAI Summarization API](https://developers.google.com/ml-kit/genai/summarization/android).<br><br><br><br> **[> Browse code](samples/genai-summarization)**<br><br> | | |
| | <img src="samples/genai-summarization/nano_summarization.png" width="150" alt="Gemini Nano summarization sample"> | ✨📱📰 **On-device Summarization**: <br>A sample letting you summarize text on-device using Gemini Nano via the [GenAI Summarization API](https://developers.google.com/ml-kit/genai/summarization/android).<br><br><br><br> **[> Browse code](samples/genai-summarization)**<br><br> | |
ai-catalog/README.md
Outdated
| | | | | ||
| | <img src="samples/genai-image-description/nano_image_description.png" width="150" alt="Gemini Nano Image description"> | ✨📱🔍 **On-device Image Description**: <br>A sample letting you generate image descriptions using Gemini Nano via the [GenAI Image Description API](https://developers.google.com/ml-kit/genai/image-description/android).<br><br><br><br> **[> Browse code](samples/genai-image-description)**<br><br> | | ||
| | | | | ||
| | <img src="samples/genai-writing-assistance/nano_rewrite.png" width="150" alt="Gemini Image Chat sample"> | ✨📱🖋️ **On-device Writing Assistance**: <br>A sample letting you proofread and rewrite text using Gemini Nano via the [GenAI Rewriting API](https://developers.google.com/ml-kit/genai/rewriting/android).<br><br><br><br> **[> Browse code](samples/genai-writing-assistance)**<br><br> | |
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.
The alt text for this image is "Gemini Image Chat sample", which appears to be a copy-paste error. It should describe the 'On-device Writing Assistance' sample for accessibility.
| | <img src="samples/genai-writing-assistance/nano_rewrite.png" width="150" alt="Gemini Image Chat sample"> | ✨📱🖋️ **On-device Writing Assistance**: <br>A sample letting you proofread and rewrite text using Gemini Nano via the [GenAI Rewriting API](https://developers.google.com/ml-kit/genai/rewriting/android).<br><br><br><br> **[> Browse code](samples/genai-writing-assistance)**<br><br> | | |
| | <img src="samples/genai-writing-assistance/nano_rewrite.png" width="150" alt="On-device Writing Assistance sample"> | ✨📱🖋️ **On-device Writing Assistance**: <br>A sample letting you proofread and rewrite text using Gemini Nano via the [GenAI Rewriting API](https://developers.google.com/ml-kit/genai/rewriting/android).<br><br><br><br> **[> Browse code](samples/genai-writing-assistance)**<br><br> | |
ai-catalog/README.md
Outdated
| | | | | ||
| | <img src="samples/imagen/imagen_image_generation.png" width="150" alt="Imagen sample"> | 🖼️ **Image Generation with Imagen**: <br>A sample using [Imagen to generate images](https://developer.android.com/ai/imagen#generate-image) of landscapes, objects and people in various artistic style.<br><br><br><br> **[> Browse code](samples/imagen)**<br><br> | | ||
| | | | | ||
| | <img src="samples/magic-selfie/magic_selfie.png" width="150" alt="Magic Selfie sample"> | 🖼️📸 **Magic Selfie**: <br>A sample using [ML Kit subject Segmentation SDK](https://developers.google.com/ml-kit/vision/subject-segmentation/android) to remove the background behind a preson, and [Imagen](https://developer.android.com/ai/imagen#generate-image) to generate new background.<br><br><br><br> **[> Browse code](samples/magic-selfie)**<br><br> | |
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.
There is a typo in the description for the 'Magic Selfie' sample. The word 'preson' should be 'person'.
| | <img src="samples/magic-selfie/magic_selfie.png" width="150" alt="Magic Selfie sample"> | 🖼️📸 **Magic Selfie**: <br>A sample using [ML Kit subject Segmentation SDK](https://developers.google.com/ml-kit/vision/subject-segmentation/android) to remove the background behind a preson, and [Imagen](https://developer.android.com/ai/imagen#generate-image) to generate new background.<br><br><br><br> **[> Browse code](samples/magic-selfie)**<br><br> | | |
| | <img src="samples/magic-selfie/magic_selfie.png" width="150" alt="Magic Selfie sample"> | 🖼️📸 **Magic Selfie**: <br>A sample using [ML Kit subject Segmentation SDK](https://developers.google.com/ml-kit/vision/subject-segmentation/android) to remove the background behind a person, and [Imagen](https://developer.android.com/ai/imagen#generate-image) to generate new background.<br><br><br><br> **[> Browse code](samples/magic-selfie)**<br><br> | |
Update main Readme.md file to include screenshot and more elaborate description for each sample.