asteroid-team / asteroid-team/asteroid

conf.yaml options vs. run.sh options

Open
#180 8 comments 1 reaction 0 assignees View on GitHub
bug help wanted
Dominant language
Python
Stars
2.6k
Forks
450
PR merge metrics
No merged PRs in 30d

Description

In the WHAM ConvTasNet scripts, you can set some options in `conf.yaml` and some options in `run.sh`. The `run.sh` ones seem to have precedence over the `conf.yaml` ones.

To me it's confusing since I do not see the reason for two places to specify these things. In practice, I never use the `run.sh` ones since I want to keep multiple model configurations anyways, so I'll end up having multiple `conf.yaml` files.

My suggestion is to remove the options from `run.sh` and add a new flag to `run.sh`, say `--conf`, that is a path to a `conf.yaml` file. This way it's obvious where the config is coming from and also you can easily switch between multiple configs.

Contributor guide

Open the contributing guide

Research direction

Inspect the WHAM ConvTasNet `run.sh` scripts and their `conf.yaml` files to map which options are duplicated and how precedence currently works. Trace how each script receives configuration, then verify that a selected config path controls the run and that the existing option sources no longer conflict.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, pytorch, shell
Domain
cli, machine-learning
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.