Add a utility for writing a barebones config file #371
+55
−1
Conversation
This file contains 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
|
The documentation is not available anymore as the PR was closed or merged. |
sgugger
reviewed
May 18, 2022
sgugger
approved these changes
May 18, 2022
sgugger
reviewed
May 18, 2022
src/accelerate/utils/other.py
Outdated
| @@ -122,11 +122,9 @@ def write_basic_config(mixed_precision="no", save_location: str = default_json_c | |||
| Args: | |||
| mixed_precision (`str`, *optional*, defaults to "no"): | |||
| Mixed Precision to use. Should be one of "no", "fp16", or "bf16" | |||
| save_location (`str`, *optional*): | |||
| save_location (`str`, *optional*, defaults to "~/.cache/huggingface/accelerate/default_config.yaml"): | |||
There was a problem hiding this comment.
This won't be the default location for everyone, so I'd just say defaults to the default config path and expand a bit in the docstring that it's inside the default cache of hugging face, and may add which env variable control it.
sgugger
reviewed
May 18, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Introduce barebones config file generator
What does this add?
This PR adds a
write_basic_configfile that will write a barebones config file automatically setting the GPU's to be the maximum GPUs available (or CPU), and takes in one param for mixed precisionWho is it for?
Folks who want to avoid running
accelerate configand for tests that need to be ran withaccelerate launch.Why is it needed?
Along with a request in the fastai integration fastai/fastai#3646, I was working on fixing up the tests we currently run and was noticing some frustration when trying to setup and configure them to be launched on multi gpu.
What parts of the API does this impact?
User-facing:
Adds a
write_basic_configconfig totest_utils/testing.py, that should be used in tests but users can optionally use it to setup a basic configuration if wanted. It will not override an already setup configuration.Basic Usage Example(s):
When would I use it, and when wouldn't I?
You'd use it when you don't want to run
accelerate configand don't care about TPU setup or a fine-grained configuration setup for multi-gpu