docs: add RAG / LLM failure-mode checklist tutorial#6931
Open
onestardao wants to merge 1 commit intoflyteorg:masterfrom
Open
docs: add RAG / LLM failure-mode checklist tutorial#6931onestardao wants to merge 1 commit intoflyteorg:masterfrom
onestardao wants to merge 1 commit intoflyteorg:masterfrom
Conversation
Signed-off-by: PSBigBig × MiniPS <psbigbig@onestardao.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #6931 +/- ##
==========================================
- Coverage 56.96% 56.95% -0.01%
==========================================
Files 929 929
Lines 58156 58156
==========================================
- Hits 33130 33125 -5
- Misses 21984 21989 +5
Partials 3042 3042
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Author
|
This PR is docs-only (just adding a link to the README). Codecov reports a -0.01% project coverage change coming from indirect changes in If needed, I’m happy to rebase so the checks can be re-run, but this looks like a coverage noise issue rather than a change introduced here. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Tracking issue
Related to #6930
Why are the changes needed?
RAG / LLM workloads on Flyte are becoming more common, but when a pipeline misbehaves it is still hard for users to reason about where the failure comes from (ingestion, embeddings, retriever, LLM, evaluation, etc.).
This PR adds a pointer to a concrete, MIT-licensed failure-mode checklist that:
What changes were proposed in this pull request?
README.md.This is intentionally a minimal docs-only change.
As a follow-up, I am interested in contributing one or two Flyte 2.0 examples that use this checklist to structure RAG / LLM workflows, based on the suggestions in #6930.
How was this patch tested?
Labels
Setup process
Not applicable – docs-only change.
Screenshots
Not applicable – README text-only change.
Check all the applicable boxes
Related PRs
None.
Docs link
Not applicable – change is in the main
README.mdonly.