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

Updated readme #73

Merged
merged 18 commits into from
May 14, 2024
Merged

Updated readme #73

merged 18 commits into from
May 14, 2024

Conversation

pavelgj
Copy link
Collaborator

@pavelgj pavelgj commented May 8, 2024

No description provided.

Verified

This commit was signed with the committer’s verified signature.
bash Tau Gärtli
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In what sense is it sandboxed? I don't understand what kind of isolation we're playing up

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Co-authored-by: Kevin Cheung <[email protected]>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
pavelgj and others added 2 commits May 8, 2024 13:19
Co-authored-by: Michael Bleigh <[email protected]>
Co-authored-by: Michael Bleigh <[email protected]>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
pavelgj and others added 13 commits May 8, 2024 14:48
Co-authored-by: Kevin Cheung <[email protected]>
Co-authored-by: Kevin Cheung <[email protected]>
Co-authored-by: Kevin Cheung <[email protected]>
Co-authored-by: Kevin Cheung <[email protected]>
Co-authored-by: Peter Friese <[email protected]>
Co-authored-by: Peter Friese <[email protected]>
Co-authored-by: Peter Friese <[email protected]>
Co-authored-by: Peter Friese <[email protected]>
Co-authored-by: Peter Friese <[email protected]>

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Firebase Genkit Team

@pavelgj pavelgj marked this pull request as ready for review May 14, 2024 18:22
@pavelgj pavelgj merged commit 8af5748 into main May 14, 2024
3 of 4 checks passed
@pavelgj pavelgj deleted the readme branch May 14, 2024 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants