spirula-studio/reference/scripts/SAM2-GUI/README.md

Forked from https://github.com/YunxuanMao/SAM2-GUI by Yunxuan Mao

Major changes

• Make it run in sequence-free format
• Upgrade sam2 to sam2.1
• Update sam2 parameters to reduce memory usage for long videos
• Save grayscale masks only
• Use multithreading for colorizing and saving masks

original README below

GUI for SAM2

A GUI tool for SAM2 video segmentation.

Installation

You should install SAM2 first.

pip install -r requirements.txt

Processing Custom Data

We highly encourage users to structure their data directories in the following way:

- data_root
    '- videos
    |   - seq1.mp4
    |   - seq2.mp4
[and/or]
    '- images
    |   - seq1
    |   - seq2
    '- ...

Usage

python mask_app.py --root_dir [data_root]

Acknowledge

The app is modified based on shape-of-motion.