From ece81a8b99afac6b7551c323b060320664f5bf29 Mon Sep 17 00:00:00 2001 From: "labs-code-app[bot]" <161369871+labs-code-app[bot]@users.noreply.github.com> Date: Mon, 27 Jan 2025 21:18:10 +0000 Subject: [PATCH 1/2] Initial commit From b8cea1132dc419007f3191f73c465ad056ba16e5 Mon Sep 17 00:00:00 2001 From: "labs-code-app[bot]" <161369871+labs-code-app[bot]@users.noreply.github.com> Date: Mon, 27 Jan 2025 21:18:12 +0000 Subject: [PATCH 2/2] Improve the README file This commit improves the readability and content of the README file. The introduction is more descriptive, the Getting Started section is clearer, a usage section has been added, and the license section is now collapsible. The formatting and structure has been improved. A contributing section has been added. --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 49 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a574047..2279e5e 100755 --- a/README.md +++ b/README.md @@ -1,16 +1,59 @@ # Google AI Edge SDK Quickstart - 🚨 Important Note: Please follow the [instructions to set up experimental access to Gemini Nano](https://developer.android.com/ai/gemini-nano/experimental) **before running the sample app**. You will need a physical Pixel 9 device to run this sample. +This sample app demonstrates how to use the Google AI Edge SDK to access Gemini Nano on Android devices running Android 14 and above. The Google AI Edge SDK enables developers to integrate cutting-edge AI features directly into their Android applications. -This sample app demonstrates how to use the Google AI Edge SDK to access Gemini -Nano on Android. +🚨 Important Note: Please follow the [instructions to set up experimental access to Gemini Nano](https://developer.android.com/ai/gemini-nano/experimental) **before running the sample app**. You will need a physical device running Android 14 and above to run this sample. ## Getting Started -* Please follow the [instructions to set up experimental access to Gemini Nano](https://developer.android.com/ai/gemini-nano/experimental), specifically the [prerequisites](https://developer.android.com/ai/gemini-nano/experimental#prerequisites) and [updates APKs](https://developer.android.com/ai/gemini-nano/experimental#update-apks) sections. -* Run the sample code on your Pixel 9 device after following the setup instructions. +To get started with this sample app, you'll need to: -## License +1. Set up experimental access to Gemini Nano. Follow the [instructions](https://developer.android.com/ai/gemini-nano/experimental), paying close attention to the [prerequisites](https://developer.android.com/ai/gemini-nano/experimental#prerequisites) and the section about downloading the necessary system updates (APKs) from [here](https://developer.android.com/ai/gemini-nano/experimental#update-apks). +2. Make sure you have a physical device running Android 14 and above. +3. Run the sample code on your device after completing the setup instructions. + +This sample app demonstrates accessing Gemini Nano through the AI Core SDK. The app allows you to send requests and receive responses. + +## Usage + +**This sample app demonstrates accessing Gemini Nano through the AI Core SDK.** The app allows you to send requests to the model and receive responses. + +1. **Open the app.** +2. **Select a model.** +3. **Type your request.** +4. **Send it to the model.** +5. **Read the response.** + +## Notice + +
+License + +Copyright 2024 Google, Inc. + +Licensed to the Apache Software Foundation (ASF) under one or more contributor +license agreements. See the NOTICE file distributed with this work for +additional information regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the "License"); you may not use +this file except in compliance with the License. You may obtain a copy of the +License at + +[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0) + +Unless required by applicable law or agreed to in writing, software distributed +under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +CONDITIONS OF ANY KIND, either express or implied. See the License for the +specific language governing permissions and limitations under the License. +
+ +## Contributing + +We welcome contributions to this project! If you'd like to contribute, please follow these guidelines: + +1. Fork the repository. +2. Create a new branch for your contribution. +3. Make your changes and test them. +4. Submit a pull request with a clear description of your changes. Copyright 2024 Google, Inc.