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

Add a check on config classes docstring checkpoints #17012

Merged

Conversation

ydshieh
Copy link
Collaborator

@ydshieh ydshieh commented Apr 29, 2022

What does this PR do?

A follow-up for #16900: add a test to make sure all config classes have at least one valid checkpoint (unless explicitly specified to ignore).

By valid, it only means the format is valid, i.e. of the form [XXX](https://huggingface.co/XXX) with XXX being any string.
A more strict verification could be implemented by trying to load the config. But maybe it is a bit too much?

Also fix 2 more config classes without valid checkpoint.

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Apr 29, 2022

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

@ydshieh ydshieh requested a review from sgugger April 29, 2022 18:48
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.

Very nice, thanks for working on this!

utils/check_config_docstrings.py Outdated Show resolved Hide resolved
@ydshieh ydshieh force-pushed the add_check_on_ckpts_in_config_docstrings branch from 4c8bf9e to 183601b Compare April 30, 2022 08:20
@ydshieh ydshieh merged commit ede5e04 into huggingface:main Apr 30, 2022
@ydshieh ydshieh deleted the add_check_on_ckpts_in_config_docstrings branch April 30, 2022 08:40
stevhliu pushed a commit to stevhliu/transformers that referenced this pull request May 3, 2022
* Add the check

* add missing ckpts

* add a list to ignore

* call the added check script

* better regex pattern

Co-authored-by: ydshieh <[email protected]>
elusenji pushed a commit to elusenji/transformers that referenced this pull request Jun 12, 2022
* Add the check

* add missing ckpts

* add a list to ignore

* call the added check script

* better regex pattern

Co-authored-by: ydshieh <[email protected]>
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