Skip to content

docs(qa_text_generation): move learn-day detail from basics into notebooks - #78

Merged
rjavadi merged 2 commits into
mainfrom
feat/prepare-for-learn-days
Sep 29, 2026
Merged

rjavadi merged 2 commits into
mainfrom
feat/prepare-for-learn-days

Conversation

@rjavadi

@rjavadi rjavadi commented Sep 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

Shortens the learn-day basics note and moves the detailed teaching material into the QA notebooks, so day-1 reading stays a map and the labs carry failure modes, generation strategies, filtering, and how to read the fine-tune comparison.

Clickup Ticket(s): N/A

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update
  • 🔧 Refactoring (no functional changes)
  • ⚡ Performance improvement
  • 🧪 Test improvements
  • 🔒 Security fix

Changes Made

  • Trim 00_basics.md: drop the golden-test, failure-mode, generation-strategy, quality-eval, and “evaluating usefulness” sections, and add a short why-0.5B / why-fine-tune-instead-of-RAG note.
  • Move the failure-mode table into 01_baseline_evaluation.ipynb and keep the scope-boundary explanation with the two source documents.
  • Add the zero-shot / one-shot / few-shot / topic-controlled strategy table to 02_synthetic_qa_generation.ipynb.
  • Add the heuristics vs LLM-as-judge checklist to 03_quality_filtering.ipynb.
  • Add the comparison flowchart and test-set delta reading table to 04_finetune_and_compare.ipynb.

Testing

  • Tests pass locally (uv run pytest tests/)
  • Type checking passes (uv run mypy <src_dir>)
  • Linting passes (uv run ruff check src_dir/)
  • Manual testing performed (describe below)

Manual testing details:

uv run pre-commit run --all-files passed (trailing whitespace, EOF, ruff, ruff format, mypy, nbqa-ruff). Notebooks were not executed.

Screenshots/Recordings

N/A

Related Issues

Relates to #73

Deployment Notes

N/A

Checklist

  • Code follows the project's style guidelines
  • Self-review of code completed
  • Documentation updated (if applicable)
  • No sensitive information (API keys, credentials) exposed

Made with Cursor

@coderabbitai

coderabbitai Bot commented Sep 28, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Repository: VectorInstitute/synthetic-data-bootcamp/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 06168b68-b46f-47c3-8b4e-2cb13f54f86c


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@fatemetkl
fatemetkl self-requested a review September 28, 2026 17:48

@fatemetkl fatemetkl left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM!

@rjavadi
rjavadi merged commit a3f7274 into main Sep 29, 2026
3 checks passed
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.

2 participants