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

specify config file path on README #2140

Merged
merged 2 commits into from
Nov 13, 2023

Conversation

kwonmha
Copy link
Contributor

@kwonmha kwonmha commented Nov 10, 2023

I had hard time figuring out how to run on multi-node configuration with the given instructions.
It looked like no configuration file argument is required and accelerate will find the generated configuration automatically.
Just few more phrases are needed.

@muellerzr , @pacman100

examples/README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@muellerzr muellerzr left a comment

Choose a reason for hiding this comment

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

Good idea, just needs some tweaks. Let's change this to have accelerate config explicitly save it to a location if we want to do so. Otherwise the latter command should be modified to show where the config coming from. These commands need to be ran quickly via copy/paste for new users. So let's go with my suggestion here and propagate it below :)

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

@kwonmha
Copy link
Contributor Author

kwonmha commented Nov 13, 2023

Good suggestion. I applied your suggestion to all proper positions.

Though it is minor issue, I'm not sure what form of the second command you wanted to be.
Because you said these commands should be run via copy/paste so I changed the second one like this to minimize modification by users.
accelerate launch --config_file config.yaml ./cv_example.py --data_dir path_to_data

But it already has --data_dir path_to_data which needs to be modified by users so the previous version was like this.
accelerate launch --config_file generated_config_file ./cv_example.py --data_dir path_to_data

@muellerzr
Copy link
Collaborator

@kwonmha the data_dir path is fine, we care about everything up-to the arguments being passed to file

Copy link
Collaborator

@muellerzr muellerzr left a comment

Choose a reason for hiding this comment

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

Thanks!

@muellerzr muellerzr merged commit 15458c5 into huggingface:main Nov 13, 2023
24 checks passed
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