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

Removing run_pl_glue.py from text classification docs, include run_xnli.py & run_tf_text_classification.py #10066

Merged
merged 6 commits into from Feb 8, 2021

Conversation

cbjuan
Copy link
Contributor

@cbjuan cbjuan commented Feb 8, 2021

What does this PR do?

Since run_pl_glue.py is not part of text-classification examples after #9010, this PR removes it from the text-classification docs. Also, it adds run_xnli.py and run_tf_text_classification.py scripts, which are in that folder now.

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?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

@sgugger may be interested in the PR, he's responsible for docs and the author of #9010

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.

Good catch! To make each version of the documentation point to the examples that go with it, the links should also be like this:

:prefix-link:`run_glue <examples/text-classification/run_glue.py>`__

This way the master will be replaced by the tag of the release when in the docs of a specific version.

@cbjuan
Copy link
Contributor Author

cbjuan commented Feb 8, 2021

Sure! Change applied

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!

One last thing, could you run make style on your branch so that the formatting is applied?

@cbjuan
Copy link
Contributor Author

cbjuan commented Feb 8, 2021

Done, command make style applied. Thanks for the guidance

Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
@cbjuan
Copy link
Contributor Author

cbjuan commented Feb 8, 2021

Build still not succeeding. I will check

@sgugger
Copy link
Collaborator

sgugger commented Feb 8, 2021

Ah yes, those links don't need the underscores! Good catch and sorry for giving you the wrong example to follow. Just waiting for the last tests and we can merge :-)

@sgugger sgugger merged commit e4bf991 into huggingface:master Feb 8, 2021
@cbjuan cbjuan deleted the removing-run_pl_glue.py-docs branch February 9, 2021 09:11
@cbjuan
Copy link
Contributor Author

cbjuan commented Feb 9, 2021

No worries, @sgugger. Thanks for the guidance :)

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.

None yet

2 participants