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

Update CLI docs and use mps rather than mps_device #814

Merged
merged 4 commits into from
Nov 2, 2022
Merged

Conversation

muellerzr
Copy link
Collaborator

@muellerzr muellerzr commented Nov 2, 2022

We have the following naming convention for device vs training schema:

Device:

  • Use device name, such as --tpu, --multi_gpu, --cpu

Training Schema

  • Use schema name with "use" in the front, such as --use_megatron_lm and --use_deepspeed

Since MPS is a torch device rather than a schema, this PR changes the flag to be --mps and adds in a future warning for --use_mps so we can be consistent 🤗

Also updates the CLI docs to reflect the latest refactorization.

@muellerzr muellerzr added the enhancement New feature or request label Nov 2, 2022
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Nov 2, 2022

The documentation is not available anymore as the PR was closed or merged.

Copy link
Collaborator

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

Thanks for the clean up!

Copy link
Contributor

@pacman100 pacman100 left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM 🤗

@muellerzr muellerzr merged commit dc9966d into main Nov 2, 2022
@muellerzr muellerzr deleted the cli-docs branch November 2, 2022 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants