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.

Sign up for GitHub

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

Update main branch README for PaLM API decommissioning #205

Merged
merged 3 commits into from
Aug 21, 2024
Merged

Update main branch README for PaLM API decommissioning #205

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6696505
Update `main` branch README for PaLM API decommissioning
andrewheard Aug 19, 2024
0d1a4b5
Reword PaLM decommissioning section instead of removing
andrewheard Aug 20, 2024
63cfec1
Add note about Vertex AI
andrewheard Aug 20, 2024
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
41 changes: 17 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,31 +98,24 @@ See
[Contributing](https://github.com/google/generative-ai-swift/blob/main/docs/CONTRIBUTING.md)
for more information on contributing to the Google AI SDK for Swift.

## Developers who use the PaLM SDK for Swift (Deprecated)

> [!IMPORTANT] The PaLM API is deprecated for use with Google AI services and
> tools (but *not* for Vertex AI). Learn more about this deprecation, its
> timeline, and how to migrate to use Gemini in the
> [PaLM API deprecation guide](http://ai.google.dev/palm_docs/deprecation).

​​If you're using the PaLM SDK for Swift, review the information below to
continue using the **deprecated** PaLM SDK until you've migrated to the new
version that allows you to use Gemini.

- To continue using PaLM models, make sure your app depends on version
[`0.3.0`](https://github.com/google/generative-ai-swift/releases/tag/0.3.0)
*up to* the next minor version
([`0.4.0`](https://github.com/google/generative-ai-swift/releases/tag/0.4.0))
of `generative-ai-swift`.

- When you're ready to use Gemini models, migrate your code to the Gemini API
and update your app's `generative-ai-swift` dependency to version `0.4.0` or
higher.

To see the PaLM documentation and code, go to the
[`palm` branch](https://github.com/google/generative-ai-swift/tree/palm).
## Developers who use the PaLM SDK for Swift (Decommissioned)

> [!IMPORTANT]
> The PaLM API is now
> [decommissioned](https://ai.google.dev/palm_docs/deprecation). This means that
> users cannot use a PaLM model in a prompt, tune a new PaLM model, or run
> inference on PaLM-tuned models.
>
> Note: This is different from the
> [Vertex AI PaLM API](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/text),
> which is scheduled to be decommissioned in October 2024.

​​If you're using the PaLM SDK for Swift, migrate your code to the Gemini API
and update your app's `generative-ai-swift` dependency to version `0.4.0` or
higher. For more information on migrating from PaLM to Gemini, see the
[migration guide](https://ai.google.dev/docs/migration_guide).

## License

The contents of this repository are licensed under the
[Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
[Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
Loading