Change arg parsing to reduce confusion for CLOSED#361
Open
FileSystemGuy wants to merge 4 commits intomainfrom
Open
Change arg parsing to reduce confusion for CLOSED#361FileSystemGuy wants to merge 4 commits intomainfrom
FileSystemGuy wants to merge 4 commits intomainfrom
Conversation
|
MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅ |
Contributor
Author
|
Well... Evidently I need to make it a real PR rather than a draft PR to engage the CI/CD testing. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Change the argument parsing in mlpstorage to reduce confusion on which arguments are permitted and which are required for each of the various workloads and submission types (eg: closed versus open). It moves to a dynamically-created arg structure where the earlier arguments determine the later arguments.
Require the first argument to be "closed" or "open" with it defaulting to "closed' if the argument is missing. The rest of the argument parsing code then is built taking that into account. Args that cannot be changed in closed are not allowed on the command line and their values are defaulted, while open allows all the args to be changed. As such, it should reduce the load on the submission validation checker, and reduce submitter confusion.
Include a unit test of the cli parsing code to validate that it is doing the correct thing. This is not a comprehensive test, it lacks negative tests.
@russfellows and @idevasena and @dslik will need to look at the list of args that are accepted in each mode.
This is a late-in-the-day change, so feel free to say that it conflicts with too many things and should be put off until after 3.0.
There isn't a good way to run the CI/CD test flow against a branch without creating a PR, so this may fail those tests and need adjustment.