Skip to main content

Helper functions for vision processing.

Project description

fsai-vision-utils

A comprehensive collection of computer vision utilities and CLI tools for COCO dataset processing, image manipulation, and machine learning workflows.

🚀 Installation

poetry add fsai-vision-utils

📋 Overview

This package provides a suite of command-line tools designed to streamline computer vision workflows, particularly for COCO format datasets. Whether you're preparing data for training, augmenting datasets, or analyzing annotations, these tools offer efficient, parallelized solutions for common computer vision tasks.

🛠️ Available CLI Tools

Data Processing & Manipulation

  • aws-batch-download - Download multiple files from S3 with multi-threading and retry logic
  • coco-resize - Resize COCO dataset images while maintaining aspect ratio and filtering annotations
  • coco-slice-dataset - Slice large images into smaller tiles for training or inference
  • coco-background-crop - Generate random background crops from COCO images for negative samples

Data Augmentation & Enhancement

  • coco-augment - Apply data augmentation to COCO datasets with bounding boxes and keypoints

Dataset Management

  • coco-merge - Merge multiple COCO datasets into a single unified dataset
  • coco-split - Split COCO datasets into train/validation/test sets with stratification
  • coco-remap - Remap COCO category IDs to be contiguous starting from 0 or 1
  • coco-combine-categories - Combine multiple categories into one with contiguous ID remapping

Analysis & Visualization

Model Configuration & Deployment

  • detectron-config - Generate Detectron2 configuration files from model zoo templates
  • detectron-strip - Extract model weights from Detectron2 checkpoints for deployment
  • coco-yolo-dataset-yaml - Build Ultralytics YOLO dataset YAML from COCO category names and list order

🎯 Quick Start Examples

Basic Dataset Processing Pipeline

# 1. Download images from S3
aws-batch-download --ids_txt_file image_ids.txt --aws_path s3://bucket/images --output_path ./images

# 2. Resize images and filter annotations
coco-resize --input-coco-json annotations.json --input-image-dir ./images --output-images-dir ./resized --output-coco-json ./resized/annotations.json --max-size 1024

# 3. Augment the dataset
coco-augment --input-json ./resized/annotations.json --input-images ./resized --output-json ./augmented/annotations.json --output-images ./augmented --num-augmentations 5

# 4. Split into train/val/test sets
coco-split --input-coco-json ./augmented/annotations.json --output-coco-dir ./splits --train-ratio 0.7 --val-ratio 0.15 --test-ratio 0.15

Large Image Processing

# Slice large images into manageable tiles
coco-slice-dataset --input-coco-json large_images.json --image-dir ./large_images --output-dir ./sliced --slice-height 1024 --slice-width 1024 --overlap-height-ratio 0.2 --overlap-width-ratio 0.2

Dataset Analysis

# Analyze object dimensions and size distributions
coco-analyze-dimensions --input-coco-json annotations.json --output-stats ./dimension_report.txt

# Count annotations by category
coco-count-annotations-by-category train.json val.json test.json --individual

# Visualize dataset interactively
coco-visualize --image-dir ./images --input-coco-json annotations.json --dataset-name "my_dataset"

🔧 Key Features

Performance & Scalability

  • Multi-threading/Multi-processing: All tools support parallel processing for optimal performance
  • Memory Efficient: Designed to handle large datasets without excessive memory usage
  • Progress Tracking: Real-time progress bars and statistics for long-running operations

Robustness & Reliability

  • Error Handling: Graceful handling of corrupted files and invalid annotations
  • Retry Logic: Automatic retry mechanisms for network operations
  • Validation: Built-in validation for COCO format compliance

Flexibility & Customization

  • Configurable Parameters: Extensive command-line options for fine-tuning behavior
  • Format Support: Support for various image formats (JPG, PNG, etc.)
  • Extensible: Modular design allows for easy extension and customization

📚 Documentation

Each CLI tool has detailed documentation with usage examples, parameter descriptions, and best practices:

🏗️ Architecture

The package is organized into several key components:

fsai_vision_utils/
├── clis/           # Command-line interface implementations
├── libs/           # Core library functions
│   ├── sahi/       # SAHI (Slicing Aided Hyper Inference) utilities
│   └── ensemble_model/  # Model ensemble utilities
└── __init__.py

🤝 Contributing

We welcome contributions! Please see our contributing guidelines for details on how to submit pull requests, report issues, and suggest improvements.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔗 Links

🆘 Support

If you encounter any issues or have questions:

  1. Check the documentation for detailed usage instructions
  2. Search existing issues for similar problems
  3. Create a new issue with a detailed description of your problem

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

fsai_vision_utils-0.0.265.tar.gz (108.4 kB view details)

Uploaded Source

Built Distribution

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

fsai_vision_utils-0.0.265-py3-none-any.whl (126.2 kB view details)

Uploaded Python 3

File details

Details for the file fsai_vision_utils-0.0.265.tar.gz.

File metadata

  • Download URL: fsai_vision_utils-0.0.265.tar.gz
  • Upload date:
  • Size: 108.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.12.3 Linux/6.17.0-1008-azure

File hashes

Hashes for fsai_vision_utils-0.0.265.tar.gz
Algorithm Hash digest
SHA256 7c90c25bedb01b3e3c8576d86a3248d113195a5b8796eeda7d4cd66f1193d5c4
MD5 bec1969b6315862ef006b2b4feaba877
BLAKE2b-256 e20f2e2fb8cd36db9fe14996d1fa06a94d907789bce115624ea847e13e550407

See more details on using hashes here.

File details

Details for the file fsai_vision_utils-0.0.265-py3-none-any.whl.

File metadata

  • Download URL: fsai_vision_utils-0.0.265-py3-none-any.whl
  • Upload date:
  • Size: 126.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.12.3 Linux/6.17.0-1008-azure

File hashes

Hashes for fsai_vision_utils-0.0.265-py3-none-any.whl
Algorithm Hash digest
SHA256 ea7c42ece18103e8c45979e06a4881047ca16c062d27d9339e18b2b6e5f8e6bb
MD5 2c968ac03bed69504ff85bb5de48e90e
BLAKE2b-256 f5f9623e207a15a91bfc720a8023fd165d5673fcfe72d08da5b223a3ed8121ac

See more details on using hashes here.

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