CoralNet-Toolbox

CoralNet-Toolbox πŸͺΈπŸ§°

CoralNet-Toolbox

🌊 Empowering Coral Reef Research with AI-Powered Annotation Tools 🌊

An unofficial toolkit to supercharge your CoralNet workflows with cutting-edge computer vision


πŸ“Š Project Stats

[![Python Version](https://img.shields.io/pypi/pyversions/CoralNet-Toolbox.svg?style=for-the-badge&logo=python&logoColor=white)](https://pypi.org/project/CoralNet-Toolbox) [![Version](https://img.shields.io/pypi/v/CoralNet-Toolbox.svg?style=for-the-badge&color=blue)](https://pypi.python.org/pypi/CoralNet-Toolbox) [![Downloads](https://img.shields.io/pepy/dt/coralnet-toolbox.svg?style=for-the-badge&color=brightgreen)](https://pepy.tech/project/coralnet-toolbox) [![PyPI Passing](https://img.shields.io/github/actions/workflow/status/Jordan-Pierce/CoralNet-Toolbox/pypi.yml?style=for-the-badge&label=PyPI%20Build&logo=github)](https://pypi.org/project/CoralNet-Toolbox) [![Windows](https://img.shields.io/github/actions/workflow/status/Jordan-Pierce/CoralNet-Toolbox/windows.yml?style=for-the-badge&label=Windows&logo=windows&logoColor=white)](https://pypi.org/project/CoralNet-Toolbox) [![macOS](https://img.shields.io/github/actions/workflow/status/Jordan-Pierce/CoralNet-Toolbox/macos.yml?style=for-the-badge&label=macOS&logo=apple&logoColor=white)](https://pypi.org/project/CoralNet-Toolbox) [![Ubuntu](https://img.shields.io/github/actions/workflow/status/Jordan-Pierce/CoralNet-Toolbox/ubuntu.yml?style=for-the-badge&label=Ubuntu&logo=ubuntu&logoColor=white)](https://pypi.org/project/CoralNet-Toolbox)

✨ Why CoralNet-Toolbox?

| 🎯 **Smart Annotation** | πŸ€– **AI-Powered** | πŸš€ **Complete Pipeline** | |:---:|:---:|:---:| | Create patches, rectangles, and polygons with intelligent assistance | Leverage SAM, YOLO, and foundation models | From data collection to deployment | | *Precision meets efficiency* | *Cutting-edge AI at your fingertips* | *End-to-end workflow automation* |

⚑ Quick Start ⚑

Get up and running in seconds:

# πŸ’» Installation
pip install coralnet-toolbox

# πŸš€ Launch
coralnet-toolbox

πŸŽ‰ That’s it! The toolbox will open and you’re ready to start annotating!

For a complete installation guide (including CUDA setup), see the Installation Documentation.


πŸ“š Documentation Hub

| πŸ“– Guide | 🎯 Purpose | πŸ”— Link | |:---:|:---:|:---:| | **Overview** | Get the big picture | [πŸ“‹ Read More](https://jordan-pierce.github.io/CoralNet-Toolbox/overview) | | **Installation** | Detailed setup instructions | [βš™οΈ Setup Guide](https://jordan-pierce.github.io/CoralNet-Toolbox/installation) | | **Usage** | Learn the tools | [πŸ› οΈ User Manual](https://jordan-pierce.github.io/CoralNet-Toolbox/usage) | | **Hot Keys** | Keyboard shortcuts | [⌨️ Shortcuts](https://jordan-pierce.github.io/CoralNet-Toolbox/hot-keys) | | **Classification** | Community tutorial | [🧠 AI Tutorial](https://jordan-pierce.github.io/CoralNet-Toolbox/classify) |

πŸŽ₯ Video Demonstrations

πŸ“Ί Watch the Complete Tutorial Series

Video Tutorial Series

🎬 Complete playlist covering all major features and workflows


πŸ€– AI Model Arsenal

The toolbox integrates state-of-the-art models for efficient annotation workflows:

### πŸ‹οΈ **Trainable Models** | **YOLO Family** | **Versions Available** | |:---:|:---:| | 🦾 **Legacy** | YOLOv3 β€’ YOLOv4 β€’ YOLOv5 | | πŸš€ **Modern** | YOLOv6 β€’ YOLOv7 β€’ YOLOv8 | | ⚑ **Latest** | YOLOv9 β€’ YOLOv10 β€’ YOLO11 β€’ YOLO12 | *Powered by the [Ultralytics](https://ultralytics.com/) ecosystem*
### 🎯 **Segment Anything Models** | **Model** | **Specialty** | **Use Case** | |:---:|:---:|:---:| | πŸͺΈ **SAM** | General segmentation | High-quality masks | | 🌊 **CoralSCOP** | Coral-specific | Marine biology focus | | ⚑ **FastSAM** | Speed optimized | Real-time annotation | | πŸ“± **MobileSAM** | Mobile-friendly | Edge deployment | | βœ‚οΈ **EdgeSAM** | Efficient | Resource-constrained | | πŸ” **RepViT-SAM** | Vision transformers | Advanced features | *Powered by our [xSAM](https://Github.com/Jordan-Pierce/xSAM) integration*
### πŸ‘οΈ **Visual Prompting & Foundation Models** | **Framework** | **Models** | **Capability** | |:---:|:---:|:---:| | **YOLOE** | See Anything | Visual prompt detection | | **Transformers** | Grounding DINO β€’ OWLViT β€’ OmDetTurbo | Zero-shot detection |

πŸ› οΈ Feature Showcase

### πŸ“ **Core Annotation Tools** | Patch Annotation
**🎯 Patch Annotation** | Rectangle Annotation
**πŸ“ Rectangle Annotation** | Polygon Annotation
**πŸ”· Multi-Polygon Annotation** | |:---:|:---:|:---:| ### πŸ€– **AI-Powered Analysis** | Classification
**🧠 Image Classification** | Object Detection
**🎯 Object Detection** | Instance Segmentation
**🎭 Instance Segmentation** | |:---:|:---:|:---:| ### πŸ”¬ **Advanced Capabilities** | SAM
**πŸͺΈ Segment Anything (SAM)** | Polygon Classification
**πŸ” Polygon Classification** | Work Areas
**πŸ“ Region-based Detection** | |:---:|:---:|:---:| ### βœ‚οΈ **Editing & Processing Tools** | Cut Tool
**βœ‚οΈ Cut** | Combine Tool
**πŸ”— Combine** | Simplify Tool
**🎨 Simplify** | |:---:|:---:|:---:| ### 🌟 **Specialized Features** | YOLOE
**πŸ‘οΈ See Anything (YOLOE)** | LAI Classification
**πŸ—ΊοΈ LAI Classification** | |:---:|:---:| ### πŸ“Š **Analysis & Exploration** | Video Analysis
**🎬 Video Inference & Analytics** | Data Explorer
**πŸ” Data Explorer & Clustering** | |:---:|:---:|

πŸ”§ Complete Workflow Pipeline

πŸ“₯ Data Input

✏️ Annotation & Labeling

🧠 Machine Learning

πŸ“Š Analysis & Export


πŸ“‹ Roadmap

See the current tickets and planned features on the GitHub Issues Page