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

Improve quality errors #1698

Merged
merged 6 commits into from
Jul 11, 2023
Merged

Improve quality errors #1698

merged 6 commits into from
Jul 11, 2023

Conversation

muellerzr
Copy link
Collaborator

@muellerzr muellerzr commented Jul 10, 2023

When quality checks fail, provides a clear error in the job summary, as seen here: https://github.com/huggingface/accelerate/actions/runs/5509213335

Quality check failed. Please ensure the right dependency versions are installed with 'pip install -e .[quality]' and rerun 'make style; make quality;'

Many users have issues with knowing what to do or how to install with it, so this is one solution I have in mind, otherwise go as far as a github bot that points to the different job summaries and their statuses/errors that automatically gets updated each push. As github doesn't just let you go "Details" and automatically see the summary

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Jul 10, 2023

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

@muellerzr muellerzr marked this pull request as ready for review July 10, 2023 14:22
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 a bunch, @muellerzr, this is nice! 🤗

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 a lot!

@muellerzr muellerzr merged commit 64d7b58 into main Jul 11, 2023
26 checks passed
@muellerzr muellerzr deleted the quality-workflow branch July 11, 2023 13:09
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.

4 participants