Skip to content

Improve and align tutorials #17

@yairallouche

Description

@yairallouche

Summary

Improve the quality, consistency, and completeness of the tutorials directory.

Tasks

1. Clean up tutorial 02 (RAG pipeline)

  • Fix broken import path (govt_data_loader vs scripts/govt_data_loader)
  • Fix threshold inconsistency between show_intermediates (0.4) and run_pipeline (0.5)
  • Remove unused ANSWERABILITY_THRESHOLD constant
  • Consolidate scattered imports
  • Refactor large function cell into smaller, focused cells
  • Add explanatory comments for non-obvious design choices (TOP_K, temperature, pipeline ordering)
  • Improve govt_data_loader.py error handling and progress feedback
  • Add diagram showing the 7-step pipeline flow, including the three exit points (blocked, unanswerable, needs clarification)

2. Align format across all tutorials

  • Convert the hello-adapter to a notebook
  • Standardize heading hierarchy (H1 title, H2 numbered sections)
  • Standardize template (intro -> prerequisite -> content -> next steps )
  • Add time estimates and prerequisites links to all tutorials
  • Add "Next Steps" sections linking to related tutorials
  • Consolidate imports in notebooks (not scattered across cells)
  • Replace ANSI color codes with display(Markdown()) in notebook 01
  • Use Rich Markdown rendering for the printing method (see RAG tutorial)
  • Add "What you will learn" to each notebook
  • Improve prose clarity across all tutorials
  • Validate clear text in all notebooks
  • Add missing context if needed (e.g., aLoRA vs LoRA explanation, attribution instruction context)
  • Provide a one-line explanation on each adapter before usage
  • Validate all links

3. Consider adding new tutorials

  • Evaluate a simpler RAG tutorial (inline docs, no vector DB) as a stepping stone
  • Evaluate a complex RAG tutorial with loop between answerability rewriting

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions