Installation
May 15, 2026 ยท View on GitHub
The project is based on Python and PyTorch. We usually run experiments with multi-GPU training.
Tested runtime:
- Python
3.12.3 - PyTorch
2.8.0+cu128
๐ฅ Clone the Git repo
$ https://github.com/yyliu01/AuralSAM2
$ cd AuralSAM2
๐งฉ Install dependencies
- create conda env from yaml
$ conda env create -f docs/auralsam2.yml
- activate env
$ conda activate auralsam2
- install PyTorch (recommended: match tested runtime)
# CUDA 12.8 (tested):
$ pip install torch==2.8.0 torchvision torchaudio --index-url https://download.pytorch.org/whl/cu128
- install python packages (if needed)
$ pip install -r docs/requirements.txt
๐๏ธ Prepare dataset
AVSBench (avs.code)
- download and prepare AVSBench under repository root.
- ensure the dataset root path is:
AVSBench/AVSBench/avss_index/metadata.csv(and subset foldersv1s/,v1m/,v2/)
Ref-AVS (ref-avs.code)
- download and prepare the Ref-AVS (REFAVS) dataset under repository root.
- ensure the dataset root path is:
REFAVS/REFAVS/metadata.csv(splits:train,test_s,test_u,test_n)
Checkpoints (shared)
Prepare under repository root:
ckpts/sam_ckpts/sam2_hiera_large.ptckpts/vggish-10086976.pth
๐๏ธ Workspace structure
AuralSAM2/
โโโ avs.code/
โ โโโ v1s.code/
โ โโโ v1m.code/
โ โโโ v2.code/
โโโ ref-avs.code/
โโโ scripts/
โ โโโ run_avs_train.sh
โ โโโ run_ref_train.sh
โโโ AVSBench/
โ โโโ avss_index
โ โ โโโ metadata.csv
โ โ โโโ metadata_v1m_man.csv
โ โ โโโ metadata_v2_man.csv
โ โโโ v1m
โ โ โโโ 01uIJMwnUvA_0
โ โ โโโ 0WxgIKuetYI_0
โ โ ... (419 more)
โ โโโ v1s
โ โ โโโ --FenyW2i_4_5000_10000
โ โ โโโ --ZHUMfueO0_5000_10000
โ โ ... (4927 more)
โ โโโ v2
โ โโโ --KCIeTv6PM_14000_24000
โ โโโ --iSerV5DbY_68000_78000
โ ... (5995 more)
โโโ REFAVS/
โ โโโ gt_mask
โ โ โโโ --KCIeTv6PM_14000_24000
โ โ โโโ --iSerV5DbY_68000_78000
โ โ ... (~4000 more)
โ โโโ media
โ โ โโโ --KCIeTv6PM_14000_24000
โ โ โโโ --iSerV5DbY_68000_78000
โ โ ... (~4300 more)
โ โโโ metadata.csv
โโโ ckpts/
โ โโโ sam_ckpts/
โ โ โโโ sam2_hiera_large.pt
โ โโโ vggish-10086976.pth
โโโ docs/
โโโ installation.md
โโโ before_start.md
โโโ requirements.txt
โโโ auralsam2.yml
๐ Notes
- use
docs/before_start.mdfor training and inference commands. - if wandb is not needed, disable online logging in your config.