Remove utils/documentation_tests.txt
#25680
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ydshieh
commented
Aug 23, 2023
Comment on lines
-399
to
-401
| # These are files not doctested yet. | ||
| with open("utils/not_doctested.txt") as fp: | ||
| not_doctested = set(fp.read().strip().split("\n")) |
Collaborator
Author
There was a problem hiding this comment.
move this to the new get_all_doctest_files above
ydshieh
commented
Aug 23, 2023
Comment on lines
-405
to
-413
|
|
||
| # So far we don't have 100% coverage for doctest. This line will be removed once we achieve 100%. | ||
| test_files_to_run = [x for x in test_files_to_run if x not in not_doctested and x not in slow_documentation_tests] | ||
|
|
||
| # The file `utils/not_doctested.txt` doesn't contain all files that are not doc-tested, so we need more filters. | ||
| # 1. only include files in `src` or `docs/source/en/` | ||
| test_files_to_run = [x for x in test_files_to_run if x.startswith(("src/", "docs/source/en/"))] | ||
| # 2. not include init files | ||
| test_files_to_run = [x for x in test_files_to_run if not x.endswith(("__init__.py",))] |
ydshieh
commented
Aug 23, 2023
Comment on lines
+383
to
+384
| # only include files in `src` or `docs/source/en/` | ||
| test_files_to_run = [x for x in test_files_to_run if x.startswith(("src/", "docs/source/en/"))] |
Collaborator
Author
There was a problem hiding this comment.
We have docs/source/es/quicktour.md tested so far with documentation_tests on daily CI. But the logic becomes a bit complex if to deal with language other than en. Let me know your preference.
ydshieh
commented
Aug 23, 2023
Comment on lines
+46
to
+52
| - name: Get doctest files | ||
| run: | | ||
| $(python3 -c 'from utils.tests_fetcher import get_all_doctest_files; to_test = get_all_doctest_files(); to_test = " ".join(to_test); fp = open("doc_tests.txt", "w"); fp.write(to_test); fp.close()') | ||
| - name: Run doctests | ||
| run: | | ||
| python3 -m pytest -v --make-reports doc_tests_gpu --doctest-modules $(cat utils/documentation_tests.txt) -sv --doctest-continue-on-failure --doctest-glob="*.md" | ||
| python3 -m pytest -v --make-reports doc_tests_gpu --doctest-modules $(cat doc_tests.txt) -sv --doctest-continue-on-failure --doctest-glob="*.md" |
Collaborator
Author
There was a problem hiding this comment.
use the new get_all_doctest_files defined below
ydshieh
commented
Aug 23, 2023
| return code_diff | ||
|
|
||
|
|
||
| def get_all_doctest_files() -> List[str]: |
Collaborator
Author
There was a problem hiding this comment.
for daily doctest CI to use
ArthurZucker
approved these changes
Aug 23, 2023
Collaborator
ArthurZucker
left a comment
ArthurZucker
left a comment
There was a problem hiding this comment.
Very cool. Hope we won't have surprises in the ci daily
Co-authored-by: Arthur <[email protected]>
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. |
Closed
parambharat
pushed a commit
to parambharat/transformers
that referenced
this pull request
Sep 26, 2023
* fix * fix * fix * fix * fix * fix * Apply suggestions from code review Co-authored-by: Arthur <[email protected]> --------- Co-authored-by: ydshieh <[email protected]> Co-authored-by: Arthur <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Let's remove
utils/documentation_tests.txtand just keepnot_doctested.txt