facebookresearch/metaseq

Convert string matches to enum comparison if possible

Open

#311 opened on Aug 20, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (701 forks)batch import
better-engconfigenhancementgood first issue

Repository metrics

Stars
 (6,195 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We have a lot of places where we do string matching, like:

https://github.com/facebookresearch/metaseq/blob/88ae968e679efbe84a8c246d1177852facfc43a2/metaseq/tasks/streaming_language_modeling.py#L339

or

https://github.com/facebookresearch/metaseq/blob/88ae968e679efbe84a8c246d1177852facfc43a2/metaseq_cli/train.py#L96

which can all be found via: ag "== \"" --py.

Convert these all to comparing against enums if possible.

Contributor guide

Research direction
Search for string literal comparisons using `ag "== \"" py` in the repository, then identify which strings correspond to known enum values. Define or reuse existing enums (e.g., from Python's enum module) and replace the string checks with enum comparisons. Ensure all occurrences are converted and tests pass.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85