How sushantgautam/medvqa works
Project type and purpose
• Project type: A Python-based CLI tool with an optional Gradio web interface.
• Purpose: Facilitate validation and submission of models to the MedVQA competition (ImageCLEFmed-MEDVQA-GI-2025). It provides a consistent CLI (“medvqa validate_and_submit …”) and a demo UI via Gradio, plus GitHub workflows for packaging and deployment.
File structure
• Top-level scripts:
• gradio_interface.py – launches a Gradio app
• medvqa/cli.py – entry point for the medvqa console command
• medvqa/competitions/gi-2025/task_1.py & task_2.py – competition-specific submission logic
• medvqa/submission_samples/… – sample scripts matching organizer requirements
• Config and packaging:
• pyproject.toml – project metadata, dependencies
• .gitignore, .gitmodules
• CI/CD:
• .github/workflows/publish.yml – PyPI publishing
• .github/workflows/gradio-app-HuggingFaceSpace.yml – deploy Gradio app to HF Spaces
• README.md outlines installation, usage, and links to competition repo.
README for additional insights
• Confirms CLI command and parameters (--competition, --task, --repo_id)
• Points to Gradio SDK config for Spaces deployment
• Emphasizes extensibility via competition modules
a. Main components
• User Interfaces
– CLI (shell)
– Gradio Web UI
• Core Library
– medvqa package (CLI handler, shared utilities)
• Competition Modules
– GI-2025 Task 1 & Task 2 logic
– Submission samples
• CI/CD Pipelines
– GitHub Actions (Publish to PyPI, Deploy to HF Spaces)
• External Services
– PyPI (package distribution)
– HuggingFace Model Hub (model repo for repo_id)
– HuggingFace Spaces (hosted Gradio app)
– ImageCLEFmed competition platform (validation rules)
b. Relationships and interactions
• User invokes CLI → medvqa/cli → loads competition module → validates & packages submission script → calls HF Hub API → pushes to model repo
• User opens Gradio UI → gradio_interface.py → uses medvqa core & competition modules to run inference or simulate submission → displays results
• GitHub commit → workflows trigger → publish new medvqa version to PyPI AND deploy updated Gradio app to HF Spaces
c. Architectural patterns and principles
• Modular design: core library + competition-specific plugins
• Separation of concerns: CLI logic, UI logic, competition logic
• Extensibility: additional competition folders can be added without touching core
• CI/CD automation for distribution and hosting
d. Key technologies and libraries
• Python packaging (pyproject.toml, pip)
• Click or argparse (implicit in cli.py)
• Gradio SDK (for web UI)
• GitHub Actions (CI/CD)
• HuggingFace Hub API
• Competition repo integration