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 (6,195 stars) (701 forks)batch import
better-engconfigenhancementgood first issue

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

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.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonEnum types
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests converting string comparisons to enum comparisons across the codebase. Start by identifying all string comparisons using `ag "== \"" py` as suggested in the issue. Relevant files include metaseq/tasks/streaming language modeling.py and metaseq cli/train.py. Review existing enum definitions in the codebase, then systematically replace string literals with enum members. Consider creating a unified enum for commonly compared strings.