Skip to content

Add end-to-end tutorial for feature extraction and evaluation#8

Open
prachitbhike wants to merge 1 commit intoYalaLab:mainfrom
prachitbhike:tutorial/add-walkthrough
Open

Add end-to-end tutorial for feature extraction and evaluation#8
prachitbhike wants to merge 1 commit intoYalaLab:mainfrom
prachitbhike:tutorial/add-walkthrough

Conversation

@prachitbhike
Copy link

Summary

  • Adds a four-part tutorial (TUTORIAL.md) walking through the full pipeline: synthetic data setup, feature extraction (CLI + Python API), evaluation, and adding a custom dataset
  • Adds tutorial/setup_tutorial.py to generate the synthetic image and labels needed by DummyDataset
  • Adds a tutorial link to README.md

Issues addressed

What's included

File Description
tutorial/setup_tutorial.py Generates assets/CXR145_IM-0290-1001.png (synthetic 1024x1024 grayscale image) and tutorial/dummy_labels.json (100 studies, 3 binary findings). Uses only PIL + stdlib.
TUTORIAL.md Four-part guide: CLI extraction, Python API, evaluation, custom datasets. Includes troubleshooting table.
README.md Added ## Tutorial section with link to TUTORIAL.md

Test plan

  • Run python tutorial/setup_tutorial.py and verify both files are created
  • Follow Part 1 commands with --max-samples 10 to verify extraction works
  • Follow Part 3 commands to verify evaluation produces output files
  • Verify labels JSON format matches discover_questions_from_json expectations

Adds a tutorial that walks through the full pipeline: generating
synthetic data, extracting embeddings (CLI and Python API), running
evaluation, and adding a custom dataset.

- tutorial/setup_tutorial.py: generates a synthetic chest X-ray image
  and dummy labels JSON so the DummyDataset works out of the box
- TUTORIAL.md: four-part guide covering extraction, Python API,
  evaluation, and custom datasets
- README.md: link to tutorial

This also provides a workaround for the missing rve package (YalaLab#5) and
explains how the model converts images to embeddings (YalaLab#7).

Closes YalaLab#2
Addresses YalaLab#5, YalaLab#7
@prachitbhike prachitbhike force-pushed the tutorial/add-walkthrough branch from 305852b to ffe685e Compare February 6, 2026 22:47
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.

Add tutorial/example

1 participant