Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Refactor] Unify the --out and --dump in tools/test.py. #1307

Merged
merged 1 commit into from
Feb 9, 2023

Conversation

mzr1996
Copy link
Member

@mzr1996 mzr1996 commented Jan 10, 2023

Motivation

The --out of tools/test.py in MMClassification and MMDetection are different. And users may be confused about the difference between --out and --dump.

Modification

Remove the --dump argument and use --out argument to output the result file.
Add a --out-item argument to specify the content of the result file.

BC-breaking

The --dump argument is not available now, and please change it to --out.
And the original --out can be replaced by --out OUT --out-item metrics

Output model predictions

# Original
python tools/test.py CONFIG CHECKPOINT --dump results.pkl

# Now
python tools/test.py CONFIG CHECKPOINT --out results.pkl

Output evaluation metrics

# Original
python tools/test.py CONFIG CHECKPOINT --out results.pkl

# Now
python tools/test.py CONFIG CHECKPOINT --out results.pkl --out-item metrics

Checklist

Before PR:

  • Pre-commit or other linting tools are used to fix the potential lint issues.
  • Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests.
  • The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, like docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with those projects, like MMDet or MMSeg.
  • CLA has been signed and all committers have signed the CLA in this PR.

Copy link
Collaborator

@Ezra-Yu Ezra-Yu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants