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

Fix broken links to distillation on index page of documentation #14722

Merged
merged 4 commits into from
Dec 15, 2021

Conversation

amitness
Copy link
Contributor

What does this PR do?

Fixes broken links to DistilGPT2, DistilRoberta, and DistilmBERT on the homepage of documentation.

image

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?

Who can review?

@sgugger

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 fixing! Could you run make fix-copies to fix the CI checks?

@amitness
Copy link
Contributor Author

@sgugger Running that command modifies index.mdx and resets the links back to the broken link. I'm not sure why that's the case.

image

@sgugger
Copy link
Collaborator

sgugger commented Dec 10, 2021

Ah you need to fix them in the main README, the rest is updated from it.

@amitness
Copy link
Contributor Author

amitness commented Dec 10, 2021

@sgugger Thank you, that makes sense. Do I need to apply these also to the language-specific READMEs or are those auto-generated?
image

@sgugger
Copy link
Collaborator

sgugger commented Dec 10, 2021

If you run make fix-copies, all your changes should be propagated.

@LysandreJik
Copy link
Member

Hello @amitness, let us know if you'd like for us to run make fix-copies on your fork (and if so, please invite us as contributors so that we may push to it!)

Thanks!

@amitness
Copy link
Contributor Author

amitness commented Dec 14, 2021

@LysandreJik I have already run make fix-copies and there are no changes to any file after running it. The CI is still failing due to some other reason.

image

This CI task says the failure is due to code quality checks in docs, but my change is only switching the links in a README. Thoughts?

@LysandreJik
Copy link
Member

Ah, indeed the error says the following:

Traceback (most recent call last):
  File "utils/style_doc.py", line 550, in <module>
    main(*args.files, max_len=args.max_len, check_only=args.check_only)
  File "utils/style_doc.py", line 538, in main
    raise ValueError(f"{len(changed)} files should be restyled!")
ValueError: 1 files should be restyled!

Exited with code exit status 1

Can you run make fixup, which should take care of everything style-related?

@amitness
Copy link
Contributor Author

@LysandreJik Thank you. That worked and I have pushed all changes.

@sgugger sgugger merged commit 851a789 into huggingface:master Dec 15, 2021
@sgugger
Copy link
Collaborator

sgugger commented Dec 15, 2021

Thanks again for fixing!

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