Skip to content

Release v0.13.2: Model Gallery TUI and Enhanced Documentation

Choose a tag to compare

View all tags
@Routhleck Routhleck released this 26 Jan 13:40
· 46 commits to master since this release
v0.13.2
20d0878

What's New

🚀 Interactive Model Gallery with Terminal UI

  • Browse and run model examples through an intuitive terminal interface
  • Launch models directly from the gallery with automatic result visualization
  • Integrated with the pipeline launcher for seamless workflow

📖 Comprehensive Pipeline Documentation

  • New ASA TUI tutorial with step-by-step guides and screenshots
  • Enhanced pipeline documentation structure
  • Chinese language support for all new tutorials

📊 Left-Right Dataset Loading Utilities

  • Easy access to Left-Right experimental data
  • Streamlined dataset download and loading functions

Major Features / Key Changes

🚀 Model Gallery TUI (PR #88)

  • New gallery module: Interactive terminal UI built with Textual for browsing model examples
  • Entry points: Added `python -m canns.pipeline.gallery` and `canns-gallery` CLI commands
  • State management: Comprehensive state tracking for gallery navigation and model execution
  • Result visualization: Automatic display of model outputs with image preview support
# Launch the model gallery
python -m canns.pipeline.gallery

# Or use the CLI command
canns-gallery

📖 ASA TUI Documentation (PR #87)

  • New tutorial: Complete Chinese tutorial for ASA TUI (`docs/zh/3_full_detail_tutorials/04_pipeline/01_asa_tui.rst`)
  • Visual guides: Added screenshots showing TUI overview, preprocessing, results, and workspace structure
  • API documentation: Updated autoapi references for pipeline modules
  • Removed deprecated content: Cleaned up old theta sweep pipeline notebook

📊 Left-Right Dataset Support

  • New functions: `get_left_right_data_session()`, `get_left_right_npz()`, `load_left_right_npz()`
  • Dataset registry: Integrated Left-Right data into the dataset loading system
  • Example usage: Updated examples to demonstrate Left-Right data loading
from canns.data import get_left_right_data_session, load_left_right_npz

# Download and load Left-Right dataset
session_file = get_left_right_data_session(session_id="example")
data = load_left_right_npz(session_file)

New Components Added

  • `src/canns/pipeline/gallery/app.py` - Main gallery TUI application (707 lines)
  • `src/canns/pipeline/gallery/runner.py` - Model execution and result handling (783 lines)
  • `src/canns/pipeline/gallery/state.py` - State management for gallery
  • `src/canns/pipeline/gallery/styles.tcss` - Textual CSS styling
  • `src/canns/pipeline/gallery/main.py` - Gallery module entry point
  • `src/canns/pipeline/main.py` - Pipeline launcher entry point
  • `src/canns/pipeline/launcher.py` - Unified pipeline launcher (81 lines)
  • `docs/zh/3_full_detail_tutorials/04_pipeline/01_asa_tui.rst` - ASA TUI tutorial (525 lines)
  • `docs/zh/3_full_detail_tutorials/04_pipeline/02_model_gallery_tui.rst` - Model Gallery TUI tutorial (233 lines)

Technical Improvements

  • Removed deprecated base class: Deleted `src/canns/pipeline/_base.py` and associated tests
  • Enhanced data loading: Added `loaders.py` module with Left-Right dataset utilities
  • Updated entry points: Added `canns-gallery` and `canns-launcher` CLI commands in `pyproject.toml`
  • Documentation structure: Reorganized pipeline tutorials with clearer hierarchy

Breaking Changes

None - all additions are backward compatible.

Files Added/Modified

  • Added: 7 new static images for documentation (ASA TUI and Gallery TUI screenshots)
  • Added: 40+ new/updated documentation files (autoapi, tutorials, API references)
  • Modified: `src/canns/data/datasets.py` - Added Left-Right dataset functions (155 lines)
  • Modified: `src/canns/pipeline/init.py` - Updated exports for new modules
  • Removed: `src/canns/pipeline/_base.py` - Deprecated base pipeline class
  • Removed: `tests/pipeline/test_base.py` - Tests for removed base class
  • Removed: `docs/zh/3_full_detail_tutorials/04_pipeline/01_theta_sweep_pipeline.ipynb` - Obsolete notebook

Full Changelog: v0.13.1...v0.13.2

Assets 2
Loading