Skip to content

Tools for panoptic segmentation and developing machine learning models for benthic imagery

License

Notifications You must be signed in to change notification settings

Jordan-Pierce/CoralNet-Toolbox

Repository files navigation

CoralNet-Toolbox πŸͺΈπŸ§°

CoralNet-Toolbox

AI-Powered Annotation for Coral Reef Analysis. An unofficial toolkit to supercharge your CoralNet workflows.

Python Version Version GitHub last commit Downloads

PyPI Passing Windows macOS Ubuntu

⚑ Get Started

1. Create Conda Environment (Recommended)

# Create and activate custom environment
conda create --name coralnet10 python=3.10 -y
conda activate coralnet10

# Install uv
pip install uv

2. (Optional) GPU Acceleration If you have an NVIDIA GPU with CUDA, install PyTorch with CUDA support for full acceleration.

# Example for CUDA 12.9; use your version of CUDA
uv pip install torch torchvision --index-url https://download.pytorch.org/whl/cu129

3. Install

# Use UV for the fastest installation
uv pip install coralnet-toolbox

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

4. Launch

coralnet-toolbox

See the Installation Guide for details on other versions.

🎯 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]

πŸ“š Resources & Advanced Details

πŸ“Ί Watch the Demo Videos

Video Tutorial Series

🎬 Complete playlist covering all major features and workflows

From Bottleneck to Pipeline

Traditional benthic imagery analysis is time-consuming. Manual annotation, data management, and model training are often separate, complex tasks. CoralNet-Toolbox unifies this process, turning a research bottleneck into an integrated, AI-accelerated pipeline.

πŸ“ 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

🌊 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.


πŸ—οΈ Repository Structure


🌍 About CoralNet

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.


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