Skip to content

Jordan-Pierce/CoralNet-Toolbox

Repository files navigation

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 Version Downloads

PyPI Passing Windows macOS Ubuntu


✨ 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
Installation Detailed setup instructions βš™οΈ Setup Guide
Usage Learn the tools πŸ› οΈ User Manual
Hot Keys Keyboard shortcuts ⌨️ Shortcuts
Classification Community tutorial 🧠 AI Tutorial

πŸŽ₯ 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 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 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

  • πŸ”₯ CoralNet Download: Retrieve source data and annotations
  • 🎬 Video Processing: Extract frames from video files
  • πŸ“Έ Image Import: Support for various image formats

✏️ Annotation & Labeling

  • πŸ‘† Manual Annotation: Intuitive point, rectangle, and polygon tools
  • πŸ€– AI-Assisted: SAM, YOLO, and visual prompting models
  • πŸ“ Precision Editing: Cut, combine, subtract, and simplify shapes

🧠 Machine Learning

  • πŸ”¬ Hyperparameter Tuning: Optimize training conditions
  • πŸš€ Model Training: Build custom classifiers and detectors
  • ⚑ Model Optimization: Production-ready deployment

πŸ“Š Analysis & Export

  • πŸ“ˆ Performance Evaluation: Comprehensive model metrics
  • 🎯 Batch Inference: Process multiple images automatically
  • πŸŽ₯ Video Analysis: Real-time processing with analytics
  • πŸ“‹ Multi-format Export: CoralNet, Viscore, TagLab, GeoJSON

πŸ“‹ Roadmap

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


πŸ’» Installation Guide

🐍 Step 1: Environment Setup

# Create a dedicated environment (recommended)
conda create --name coralnet10 python=3.10 -y
conda activate coralnet10

⚑ Step 2: Fast Installation with UV

# Install UV for faster package management
pip install uv

# Install CoralNet-Toolbox
uv pip install coralnet-toolbox

Fallback: If UV fails, use regular pip: pip install coralnet-toolbox

πŸš€ Step 3: GPU Acceleration (Optional)

For CUDA-enabled systems:

# Example for CUDA 12.9
# Install PyTorch with CUDA support
uv pip install torch torchvision --index-url https://download.pytorch.org/whl/cu129 --upgrade

πŸƒβ€β™‚οΈ Step 4: Launch

coralnet-toolbox

🎯 GPU Status Indicators

  • 🐒 CPU only
  • πŸ‡ Single GPU
  • πŸš€ Multiple GPUs
  • 🍎 Mac Metal (Apple Silicon)

Click the icon in the bottom-left to see available devices

πŸ”„ Upgrading

# When updates are available
uv pip install -U coralnet-toolbox==[latest_version]

πŸ—οΈ Repository Structure


🌊 Success Stories

Using CoralNet-Toolbox in your research?

We'd love to feature your work! Share your success stories to help others learn and get inspired.


🌍 About CoralNet

πŸͺΈ Protecting our oceans, one annotation at a time πŸͺΈ

Coral reefs are among Earth's most biodiverse ecosystems, supporting marine life and coastal communities worldwide. However, they face unprecedented threats from climate change, pollution, and human activities.

CoralNet is a revolutionary platform enabling researchers to:

  • Upload and analyze coral reef photographs
  • Create detailed species annotations
  • Build AI-powered classification models
  • Collaborate with the global research community

The CoralNet-Toolbox extends this mission by providing advanced AI tools that accelerate research and improve annotation quality.


πŸ“„ Citation

If you use CoralNet-Toolbox in your research, please cite:

@misc{CoralNet-Toolbox,
  author = {Pierce, Jordan and Battista, Tim and Kuester, Falko},
  title = {CoralNet-Toolbox: Tools for Annotating and Developing Machine Learning Models for Benthic Imagery},
  year = {2025},
  howpublished = {\url{https://github.com/Jordan-Pierce/CoralNet-Toolbox}},
  note = {GitHub repository}
}

βš–οΈ Legal & Licensing

⚠️ Disclaimer

This is a scientific product and not official communication of NOAA or the US Department of Commerce. All code is provided 'as is' - users assume responsibility for its use.

πŸ“‹ License

Software created by US Government employees is not subject to copyright in the United States (17 U.S.C. Β§105). The Department of Commerce reserves rights to seek copyright protection in other countries.


🌊 Built with ❀️ for coral reef conservation 🌊

Empowering researchers β€’ Protecting ecosystems β€’ Advancing science