bytedance / bytedance/SALMONN

CLI help advertises an unimplemented --cfg-options flag

Open
#136 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
1.5k
Forks
124
Avg merge
20h 31m
Merged PRs (30d)
2

Description

Problem

The --options help text in all three SALMONN entry points says that the option is deprecated and users should switch to --cfg-options. However, none of the parsers registers a --cfg-options argument.

Affected source: salmonn branch at a58bba799a2eec05df09df102553f5c623808c12.

Affected entry points:

  • train.py
  • cli_inference.py
  • web_demo.py

Reproduction

Search the parser definitions for --options and --cfg-options. Each entry point registers --options, while --cfg-options appears only inside the help string.

Passing the recommended flag therefore produces an unrecognized-argument error once the application's dependencies are installed.

Expected behavior

CLI help should describe the option that users can actually pass, or the recommended replacement should be implemented consistently.

Actual behavior

The help directs users away from the working flag to a flag that does not exist.

Suggested fix

Keep the existing --options interface and change its help text to describe the supported key=value overrides. This avoids an unnecessary CLI compatibility change.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in train.py, cli_inference.py, and web_demo.py by inspecting the parser definitions for --options and --cfg-options. Update the existing --options help text so it describes the supported key=value overrides without advertising an unavailable flag, then verify the help output and argument parsing for all three entry points.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
82/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.