Skip to main content

DeepSeaAI is a Python package to simplify processing deep sea video in AWS from a command line.

Project description

MBARI semantic-release license-GPL Python

DeepSeaAI is a Python package to simplify processing deep sea video in AWS from a command line.

It includes reasonable defaults that have been optimized for deep sea video. The goal is to simplify running these algorithms in AWS.

DeepSea-AI currently supports:

  • Training YOLOv5 object detection models
  • Processing video with YOLOv5 detection and tracking pipelines using either:

Install

There are two main requirements to use this:

  1. An account with AWS Amazon Web Services.
  2. An account with Docker.
  3. Install and update using pip in a Python>=3.8.0 environment:

After you have setup your AWS account, configure it using the awscli tool

pip install awscli
aws configure
aws --version

Then install the module

pip install -U deepsea-ai

Setting up the AWS environment is done with the setup mirror command. This only needs to be done once, or when you upgrade the module. This command will setup the appropriate AWS permissions and mirror the images used in the commands from Docker Hub to your ECR Elastic Container Registry.

Be patient - this takes a while, but only needs to be run once.

deepsea-ai setup --mirror

Tutorials

  • FathomNet ✨ Recommended first step to learn more about how to train a YOLOv5 object detection model using freely available FathomNet data

Create the Anaconda environment

The fastest way to get started is to use the Anaconda environment. This will create a conda environment called deepsea-ai and make that available in your local jupyter notebook as the kernel named deepsea-ai

conda env create 
conda activate deepsea-ai
pip install ipykernel
python -m ipykernel install --user --name=deepsea-ai

Launch jupyter

cd docs/notebooks
jupyter notebook

Commands

Source code is available at github.com/mbari-org/deepsea-ai.

For more details, see the official documentation.

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

deepsea_ai-1.19.0.tar.gz (25.1 kB view hashes)

Uploaded Source

Built Distribution

deepsea_ai-1.19.0-py3-none-any.whl (34.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page