facebookresearch/fairseq

`fairseq_cli/*.py` should report a more specific error for unrecognized CLI arguments

Open

#3,403 opened on Mar 26, 2021

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (6,224 forks)batch import
enhancementhelp wantedneeds triagestale

Repository metrics

Stars
 (29,107 stars)
PR merge metrics
 (PR metrics pending)

Description

🚀 Feature Request

Right now, the error prints the entire command almost as is. Instead, try to parse and let argparse print a more specific error for wrong or missing flags.

Motivation

The current behavior is frustrating for debugging :(

Pitch

See ## Feature Request

Alternatives

Additional context

Contributor guide

Research direction
Examine the CLI entry points in fairseq cli/*.py, locate where argparse is configured, and enhance error handling to provide specific messages for unrecognized or missing arguments.
Tech stack
python
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75