cookbook(evaluation): revamp eval-correction-loop notebook to playbook - #8
Open
SuhaniNagpal7 wants to merge 1 commit into
Open
cookbook(evaluation): revamp eval-correction-loop notebook to playbook#8SuhaniNagpal7 wants to merge 1 commit into
SuhaniNagpal7 wants to merge 1 commit into
Conversation
Mirrors the docs MDX revamp (future-agi/docs PR #660) and aligns with the playbook's 8-cell notebook structure: - Cell 0 split: title + Colab/GitHub badges + meta table + TL;DR only. - New cells: "What you'll build", "Prerequisites" (with structured Last tested with), "Why this matters" (concrete production-incident lead). - Pinned install: `ai-evaluation>=2.0,<3` + `requests>=2.31`. - Env setup replaced with `getpass` + `RuntimeError` on missing keys. - Smoke-test FutureAGI auth cell: one fi.evals `is_helpful` probe that asserts results came back before the rest of the notebook runs. - Step 4 code cell prints the dashboard URL alongside expected output. - Troubleshooting markdown table with symptom / cause / fix / verify columns. - Explore further -> Next steps technical ladder + Colab/GitHub badges. - Version printout code cell at the end for reproducible bug reports.
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
1 participant
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.
Summary
Notebook companion to future-agi/docs#660. Brings
evaluation/eval-correction-loop.ipynbto the playbook's 8-cell structure: pinned install,getpass+ raise env setup, smoke-test FutureAGI auth, dashboard URL print after the agreement measurement, troubleshooting table, technical-ladder Next steps with Colab/GitHub badges, and a version-printout cell.Also adds the playbook frame-of-mind to the markdown intro: "What you'll build", "Prerequisites" (with structured
Last tested with), and "Why this matters" anchored in a real production-incident shape.Test plan
FI_API_KEYandFI_SECRET_KEYviagetpass(no hardcoded placeholders).fi.evals auth ok | probe result: ....agreement: 4 / 4 (100%)followed by the dashboard URL.python,requests, andai-evaluationversions.Scope
evaluation/eval-correction-loop.ipynb. Other modified notebooks (e.g.command-center/semantic-caching.ipynb) are intentionally not in this PR.