Skip to content
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

[Jules] Improved readme #15

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 49 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

<details>
<summary>License</summary>

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.
</details>

## 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.

Expand Down