Skip to content

mark as deprecated in readme #66

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

Merged
merged 3 commits into from
Mar 19, 2025
Merged
Show file tree
Hide file tree
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
17 changes: 3 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
# Retrieval Augmented Generation
# ⚠️ NOTICE

Please visit http://ai-cookbook.io for the accompanying documentation for this repo.
This repo and http://ai-cookbook.io have been deprecated. Please visit the [AWS](https://docs.databricks.com/aws/en/generative-ai/tutorials/ai-cookbook/) or [Azure](https://learn.microsoft.com/en-us/azure/databricks/generative-ai/tutorials/ai-cookbook/) Databricks documentation for the latest content.

This repo provides [learning materials](https://ai-cookbook.io/) and [production-ready code](https://github.com/databricks/genai-cookbook/tree/v0.2.0/agent_app_sample_code) to build a **high-quality RAG application** using Databricks. The [Mosaic Generative AI Cookbook](https://ai-cookbook.io/) provides:
- A conceptual overview and deep dive into various Generative AI design patterns, such as Prompt Engineering, Agents, RAG, and Fine Tuning
- An overview of Evaluation-Driven development
- The theory of every parameter/knob that impacts quality
- How to root cause quality issues and detemermine which knobs are relevant to experiment with for your use case
- Best practices for how to experiment with each knob

The [provided code](https://github.com/databricks/genai-cookbook/tree/v0.2.0/agent_app_sample_code) is intended for use with the Databricks platform. Specifically:
- [Mosaic AI Agent Framework](https://docs.databricks.com/en/generative-ai/retrieval-augmented-generation.html) which provides a fast developer workflow with enterprise-ready LLMops & governance
- [Mosaic AI Agent Evaluation](https://docs.databricks.com/en/generative-ai/agent-evaluation/index.html) which provides reliable, quality measurement using proprietary AI-assisted LLM judges to measure quality metrics that are powered by human feedback collected through an intuitive web-based chat UI

![Alt text](rag_app_sample_code/dbxquality.png)
To see the old README.md, go [here](./old_README.md).
18 changes: 18 additions & 0 deletions old_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Retrieval Augmented Generation

Please visit http://ai-cookbook.io for the accompanying documentation for this repo.

This repo provides [learning materials](https://ai-cookbook.io/) and [production-ready code](https://github.com/databricks/genai-cookbook/tree/v0.2.0/agent_app_sample_code) to build a **high-quality RAG application** using Databricks. The [Mosaic Generative AI Cookbook](https://ai-cookbook.io/) provides:

- A conceptual overview and deep dive into various Generative AI design patterns, such as Prompt Engineering, Agents, RAG, and Fine Tuning
- An overview of Evaluation-Driven development
- The theory of every parameter/knob that impacts quality
- How to root cause quality issues and detemermine which knobs are relevant to experiment with for your use case
- Best practices for how to experiment with each knob

The [provided code](https://github.com/databricks/genai-cookbook/tree/v0.2.0/agent_app_sample_code) is intended for use with the Databricks platform. Specifically:

- [Mosaic AI Agent Framework](https://docs.databricks.com/en/generative-ai/retrieval-augmented-generation.html) which provides a fast developer workflow with enterprise-ready LLMops & governance
- [Mosaic AI Agent Evaluation](https://docs.databricks.com/en/generative-ai/agent-evaluation/index.html) which provides reliable, quality measurement using proprietary AI-assisted LLM judges to measure quality metrics that are powered by human feedback collected through an intuitive web-based chat UI

![Alt text](rag_app_sample_code/dbxquality.png)
Loading