Updated readme #73
Merged
Updated readme #73
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kevinthecheung
requested changes
May 8, 2024
|
|
||
| Key features: | ||
|
|
||
| - **Action Runners:** Sandboxed environments that let developers run Genkit flows and perform other actions like chatting with models, running structured prompts or testing retrievers. |
Contributor
There was a problem hiding this comment.
In what sense is it sandboxed? I don't understand what kind of isolation we're playing up
Collaborator
Author
There was a problem hiding this comment.
I don't agree with this term either. There's no sandboxing/isolation happening. We even don't really like calling it "emulator" because we're not emulating anything. The only thing is that we're emulating observability, so it's "isolated" in that sense, but a stretch IMO. @chrisraygill
Co-authored-by: Kevin Cheung <kevinthecheung@users.noreply.github.com>
mbleigh
reviewed
May 8, 2024
Co-authored-by: Michael Bleigh <bleigh@google.com>
Co-authored-by: Michael Bleigh <bleigh@google.com>
peterfriese
requested changes
May 8, 2024
Co-authored-by: Kevin Cheung <kevinthecheung@users.noreply.github.com>
Co-authored-by: Kevin Cheung <kevinthecheung@users.noreply.github.com>
Co-authored-by: Kevin Cheung <kevinthecheung@users.noreply.github.com>
Co-authored-by: Kevin Cheung <kevinthecheung@users.noreply.github.com>
Co-authored-by: Peter Friese <peter@peterfriese.de>
Co-authored-by: Peter Friese <peter@peterfriese.de>
Co-authored-by: Peter Friese <peter@peterfriese.de>
Co-authored-by: Peter Friese <peter@peterfriese.de>
Co-authored-by: Peter Friese <peter@peterfriese.de>
kevinthecheung
requested changes
May 14, 2024
|  | ||
|
|
||
| More details coming soon... | ||
| Firebase Genkit (beta) is a framework with powerful tooling to help app developers build, test, deploy, and monitor AI-powered features with confidence. Genkit is also built from the ground up to be cloud optimized and code-centric, designed to feel familiar to most developers with less new concepts to learn. The Genkit framework itself is free and [open source](./LICENSE), and integrates with many services that have free tiers to get started. |
Contributor
There was a problem hiding this comment.
Suggested change
| Firebase Genkit (beta) is a framework with powerful tooling to help app developers build, test, deploy, and monitor AI-powered features with confidence. Genkit is also built from the ground up to be cloud optimized and code-centric, designed to feel familiar to most developers with less new concepts to learn. The Genkit framework itself is free and [open source](./LICENSE), and integrates with many services that have free tiers to get started. | |
| Firebase Genkit (beta) is a framework with powerful tooling to help app developers build, test, deploy, and monitor AI-powered features with confidence. Genkit is also built from the ground up to be cloud-optimized and code-centric, designed to feel familiar to most developers with fewer new concepts to learn. The Genkit framework itself is free and [open source](./LICENSE), and integrates with many services that have free tiers to get started. |
| Genkit is available for [TypeScript (Node.js)](https://www.npmjs.com/package/genkit), with [Go support](https://github.com/firebase/genkit/tree/main/go) in active development. | ||
|
|
||
| > [!NOTE] | ||
| > Since Genkit is currently in beta, this means that the public API and framework design may change in backward-incompatible ways. |
Contributor
There was a problem hiding this comment.
Suggested change
| > Since Genkit is currently in beta, this means that the public API and framework design may change in backward-incompatible ways. | |
| > Since Genkit is currently in beta, the public API and framework design may change in backward-incompatible ways. |
Comment on lines
+10
to
+12
| Getting started is easy: | ||
|
|
||
| Install Genkit: |
Contributor
There was a problem hiding this comment.
Suggested change
| Getting started is easy: | |
| Install Genkit: | |
| Install Genkit: |
|
|
||
| Key features: | ||
|
|
||
| - **Action Runners:** Sandboxed environments that let developers run Genkit flows and perform other actions like chatting with models, running structured prompts or testing retrievers. |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Action Runners:** Sandboxed environments that let developers run Genkit flows and perform other actions like chatting with models, running structured prompts or testing retrievers. | |
| - **Action Runners:** Locally run Genkit flows and perform other actions like chatting with models, running structured prompts or testing retrievers. |
|
|
||
| ## Google Cloud and Firebase integrations | ||
|
|
||
| Genkit works great out-of-the-box with Firebase or Google Cloud projects thanks to official plugins and templates that make it easy to integrate Google Cloud and Firebase services for AI, databases, monitoring, authentication, and deployment. These include: |
Contributor
There was a problem hiding this comment.
Suggested change
| Genkit works great out-of-the-box with Firebase or Google Cloud projects thanks to official plugins and templates that make it easy to integrate Google Cloud and Firebase services for AI, databases, monitoring, authentication, and deployment. These include: | |
| Genkit works great out-of-the-box with Firebase or Google Cloud projects thanks to official plugins that make it easy to integrate Google Cloud and Firebase services for AI, databases, monitoring, authentication, and deployment. These include: |
Comment on lines
+91
to
+92
| - [Ollama plugin](https://firebase.google.com/docs/genkit/plugins/ollama): Integrate with Ollama to access popular OSS models like Google’s Gemma. | ||
| - [pgvector template](https://firebase.google.com/docs/genkit/templates/pgvector): See our template for integrating with pgvector for CloudSQL and AlloyDB. |
Contributor
There was a problem hiding this comment.
Suggested change
| - [Ollama plugin](https://firebase.google.com/docs/genkit/plugins/ollama): Integrate with Ollama to access popular OSS models like Google’s Gemma. | |
| - [pgvector template](https://firebase.google.com/docs/genkit/templates/pgvector): See our template for integrating with pgvector for CloudSQL and AlloyDB. |
(heading says gcp and firebase)
Comment on lines
+101
to
+102
|
|
||
| Firebase Genkit Team |
Contributor
There was a problem hiding this comment.
Suggested change
| Firebase Genkit Team |
kevinthecheung
approved these changes
May 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.