coralnet-toolbox 1.0.3

Tools for annotating and developing ML models for benthic imagery

CoralNet-Toolbox 🪸🧰

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

⚡ 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.8; use your version of CUDA
uv pip install torch torchvision --index-url https://download.pytorch.org/whl/cu128

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

To remove a problematic package, type the following:

uv pip uninstall package-name-here

To delete an old environment and restart, type the following:

# Deactivate if already in the environment
conda deactivate coralnet10

# Delete by name
conda env remove --name coralnet10

# Confirm when prompted
y

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]

Note: If you have torch installed with CUDA, adding -U may trigger an regression to the CPU version. If this occurs, use pip to uninstall torch and torchvision, and re-install CUDA version.

MacOS Users

Version 1.0.0 and greater relies heavily on a package (PyQtADS) that cannot be installed on your operating system. Please do not upgrade from 0.0.105 until this is resolved.

---

📚 Resources & Advanced Details

• Installation Guide: Detailed setup for CUDA, Windows, and Mac.
• User Manual: A complete guide to all tools and features.
• Hot Keys: Keyboard shortcuts to accelerate your workflow.
• AI Tutorial: Learn to train your own classification models.

📺 Watch the Demo Videos

🎬 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	📐 Rectangle Annotation	🔷 Multi-Polygon Annotation

🤖 AI-Powered Analysis

🧠 Image Classification	🎯 Object Detection	🎭 Instance Segmentation

🔬 Advanced Capabilities

🪸 Segment Anything (SAM)	🔍 Polygon Classification	📍 Region-based Detection

✂️ Editing & Processing Tools

✂️ Cut	🔗 Combine	🎨 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