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

Docs: Resolve various typos #56

Merged
merged 3 commits into from
Sep 15, 2023
Merged

Conversation

tomaarsen
Copy link
Member

Hello!

Pull Request overview

  • Fix various typos.

Details

I found the first few manually in the README, and then found the rest via codespell.

Note

There's another typo which seems more critical to the behaviour of the package, so I did not change that one:

"overall_training.throughput(samles/s)": (trainer_state.overall_training_samples_per_second),

samles should be samples. Because of this, a bunch of the csv's also have this samles: https://github.com/huggingface/optimum-benchmark/blob/90ad2ea78d23ad59ef23ee9552a1c484706ec336/examples/training-llamas/experiments/A100-80GB/llama_peft%2Bbnb_batch_size(2)/1/training_results.csv

I'll leave this one for you to fix, as I'm not sure how it all connects together.

  • Tom Aarsen

Both manually and using 'codespell'
@IlyasMoutawwakil
Copy link
Member

Thanks a lott! definitely need to integrate a codespell workflow!

@IlyasMoutawwakil
Copy link
Member

@tomaarsen can you run make style

@tomaarsen
Copy link
Member Author

Of course! Done.

And don't bother with integrating codespell in a CI or something - it makes a lot of mistakes too, so it requires a manual look :)

@tomaarsen
Copy link
Member Author

Oh, I'm probably using a different version of black

@IlyasMoutawwakil
Copy link
Member

IlyasMoutawwakil commented Sep 15, 2023

Thanks, will correct the remaining one later

@IlyasMoutawwakil IlyasMoutawwakil merged commit 9c672c2 into huggingface:main Sep 15, 2023
@tomaarsen tomaarsen deleted the typos branch September 15, 2023 12:44
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.

2 participants