Skip to main content

A PyTorch library for vessel and fundus image analysis (simplified rewrite)

Project description

vascx_simplify

A PyTorch library for vessel and fundus image analysis, providing GPU-accelerated preprocessing and inference utilities for medical imaging tasks.

Note: This is a simplified rewrite of rtnls_vascx_models by Eyened.

AI Usage Disclaimer

This project was developed with significant assistance from AI tools (GitHub Copilot, ChatGPT, Claude) for code organization, refactoring, documentation, and packaging.

Features

  • GPU-Accelerated Preprocessing: Fast fundus image contrast enhancement with mixed precision support
  • Sliding Window Inference: Efficient inference for large images
  • Ensemble Models: Segmentation, classification, regression, and heatmap-based models
  • HuggingFace Integration: Easy model loading from HuggingFace Hub
  • Minimal Dependencies: Uses fewer dependency libraries for easier installation and maintenance

Installation

pip install vascx_simplify

From source:

git clone https://github.com/kapong/vascx_simplify.git
cd vascx_simplify
pip install -e .

Requirements

  • Python >= 3.12
  • PyTorch >= 1.10.0
  • kornia >= 0.6.0
  • scikit-learn >= 1.0.0
  • scipy >= 1.7.0
  • numpy >= 1.21.0
  • huggingface-hub >= 0.10.0

Usage Examples

Artery/Vein Segmentation

Segment arteries (red), veins (blue), and crossings (green) from fundus images:

from vascx_simplify import EnsembleSegmentation, VASCXTransform, from_huggingface
from PIL import Image
import torch

# Load model
model_path = from_huggingface('Eyened/vascx:artery_vein/av_july24.pt')
model = EnsembleSegmentation(model_path, VASCXTransform())

# Predict
rgb_image = Image.open('fundus.jpg')
prediction = model.predict(rgb_image)  # Returns [B, H, W] with class values

Artery/Vein Segmentation Result

Optic Disc Segmentation

Detect and segment the optic disc:

from vascx_simplify import EnsembleSegmentation, VASCXTransform, from_huggingface
from PIL import Image

model_path = from_huggingface('Eyened/vascx:disc/disc_july24.pt')
model = EnsembleSegmentation(model_path, VASCXTransform(512))

rgb_image = Image.open('fundus.jpg')
prediction = model.predict(rgb_image)  # Returns [B, H, W] with class values

Optic Disc Segmentation Result

Fovea Detection

Locate the fovea center using heatmap regression:

from vascx_simplify import HeatmapRegressionEnsemble, VASCXTransform, from_huggingface
from PIL import Image

model_path = from_huggingface('Eyened/vascx:fovea/fovea_july24.pt')
model = HeatmapRegressionEnsemble(model_path, VASCXTransform())

rgb_image = Image.open('fundus.jpg')
prediction = model.predict(rgb_image)  # Returns [B, M, 2] with (x, y) coordinates

fovea_x = prediction[0, 0, 0].item()
fovea_y = prediction[0, 0, 1].item()

Fovea Detection Result

Image Quality Assessment

Classify fundus image quality (Reject/Usable/Good):

from vascx_simplify import ClassificationEnsemble, VASCXTransform, from_huggingface
from PIL import Image

model_path = from_huggingface('Eyened/vascx:quality/quality.pt')
model = ClassificationEnsemble(model_path, VASCXTransform(have_ce=False))

rgb_image = Image.open('fundus.jpg')
prediction = model.predict(rgb_image)  # Returns [B, 3] with quality scores (already softmaxed)

# Get probabilities (already normalized)
q1_reject, q2_usable, q3_good = prediction[0].tolist()

Image Quality Classification Result

Batch Processing

Process multiple images efficiently with automatic batch splitting to prevent out-of-memory errors:

from vascx_simplify import EnsembleSegmentation, VASCXTransform, from_huggingface
from PIL import Image

# Load model once
model_path = from_huggingface('Eyened/vascx:artery_vein/av_july24.pt')
model = EnsembleSegmentation(model_path, VASCXTransform())

# Load multiple images
images = [Image.open(f'fundus_{i}.jpg') for i in range(10)]

# Batch prediction (much faster than sequential processing)
predictions = model.predict(images)  # Returns [10, H, W]
# Automatically splits into chunks of 4 (default for segmentation)

# Process each result
for i, pred in enumerate(predictions):
    # pred is [H, W] - no need for [0] indexing
    save_prediction(pred, f'result_{i}.png')

# For large datasets, automatic splitting prevents OOM
large_images = [Image.open(f'img_{i}.jpg') for i in range(100)]
predictions = model.predict(large_images)  # Auto-splits into chunks
# Returns [100, H, W] - seamlessly handles large batches

# Override batch size for your GPU memory
predictions = model.predict(images, batch_size=8)  # Process 8 at once

Key Features:

  • 🚀 2-3x faster than processing images sequentially
  • 🛡️ Automatic OOM prevention - large batches split automatically
  • 🔄 100% backward compatible - existing single-image code works unchanged
  • ⚙️ Configurable - override batch size per call or use smart defaults
  • 📊 Flexible inputs - accepts PIL.Image, torch.Tensor, or lists of either

Memory Management: Each model type has sensible default batch sizes:

  • Segmentation: 4 images (sliding window is memory-intensive)
  • Classification: 16 images (lightweight forward pass)
  • Regression: 16 images
  • Heatmap: 2 images (heatmaps are very memory-intensive)

Usage Patterns:

# Pattern 1: Batch processing a directory
import glob
from pathlib import Path

image_paths = glob.glob('fundus_images/*.jpg')
images = [Image.open(p) for p in image_paths]
predictions = model.predict(images)  # Efficient batch processing

# Pattern 2: Process with torch tensors
tensors = [torch.randn(3, 512, 512) for _ in range(20)]
predictions = model.predict(tensors)  # Works with tensors too

# Pattern 3: Memory-constrained environment
predictions = model.predict(images, batch_size=2)  # Smaller batches

# Pattern 4: High-memory GPU
predictions = model.predict(images, batch_size=16)  # Larger batches

Backward Compatibility: All existing single-image code works without modification:

# This still works exactly as before
image = Image.open('fundus.jpg')
pred = model.predict(image)  # Returns [1, H, W]
result = pred[0]  # Access with [0] as before

Performance Tips:

  • Use batch processing for 3+ images to see significant speedup
  • Default batch sizes are optimized for most GPUs (8-16GB VRAM)
  • Increase batch_size for high-memory GPUs (24GB+)
  • Decrease batch_size if you encounter OOM errors
  • List of tensors is slightly faster than list of PIL.Images

See examples/05_batch_processing.py for a complete performance demonstration.

License

MIT License - see LICENSE file for details.

Author

Phongphan Phienphanich garpong@gmail.com

Acknowledgments

This is a simplified rewrite of rtnls_vascx_models by Eyened.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vascx_simplify-0.1.6.tar.gz (23.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vascx_simplify-0.1.6-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

Details for the file vascx_simplify-0.1.6.tar.gz.

File metadata

  • Download URL: vascx_simplify-0.1.6.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vascx_simplify-0.1.6.tar.gz
Algorithm Hash digest
SHA256 6efded951f12e5a8f38dd9d1b05082000e8388d721f147db3f5094145098a2ff
MD5 7b30f41ea58deba5b5ebe89ddb799fcb
BLAKE2b-256 b8ac4b8c072bb198cb2a7dcac979a8b8aa934fe3dbbadcb9d07a82a7aae9ac87

See more details on using hashes here.

Provenance

The following attestation bundles were made for vascx_simplify-0.1.6.tar.gz:

Publisher: build-and-publish.yml on kapong/vascx_simplify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vascx_simplify-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: vascx_simplify-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 21.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vascx_simplify-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5b6c542dd082997a217ac9b546f6ce44426cdfb462e238e97e8d8f5447429f98
MD5 2246efa59154c876503623431d2d6f88
BLAKE2b-256 f7292fa2ac624fa22d94b6f021172b45de6e620dc7ee8df94acaadadfa822ce4

See more details on using hashes here.

Provenance

The following attestation bundles were made for vascx_simplify-0.1.6-py3-none-any.whl:

Publisher: build-and-publish.yml on kapong/vascx_simplify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page