Add doctests #7145
Add doctests #7145
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
.github/workflows/check_links.yml
Outdated
|
|
||
| jobs: | ||
| run_doctests: | ||
| runs-on: [single-gpu, nvidia-gpu, a10, ci] |
There was a problem hiding this comment.
Hmm, I suspect some snippets might OOM out in case they don't have the memory optimization bits enabled? I know we cannot catch it early. Just making a note here.
utils/not_doctested.txt
Outdated
| @@ -0,0 +1,135 @@ | |||
| docs/source/en/quicktour.md | |||
There was a problem hiding this comment.
On what basis are these added?
There was a problem hiding this comment.
Files are added here if they're too big or heavy to run and test the code I believe, so we might be able to take quicktour out since its pretty light (and there are probably others)?
There was a problem hiding this comment.
Sure. Do we add these manually?
There was a problem hiding this comment.
Yes they have been added manually or now. We most likely will have to run this workflow at least once to get an idea of how long some of the tests take and make changes accordingly.
I've updated it so that the files mentioned here exclude training examples or translations of the english docs (since the code snippets are the same).
sayakpaul
left a comment
sayakpaul
left a comment
There was a problem hiding this comment.
Left some initial comments.
Co-authored-by: Sayak Paul <[email protected]>
sayakpaul
left a comment
sayakpaul
left a comment
There was a problem hiding this comment.
Looking nice.
Would be nice to see a single instance of this test running on this PR to ensure it's working as expected.
Maybe we could limit the number of the doctests for that purpose and change the workflow trigger? And then once things are looking fine, we can swap them back to the original (as is the case currently).
| name: Check for Broken Links | ||
|
|
||
| on: | ||
| repository_dispatch: |
There was a problem hiding this comment.
Why is it a repository dispatch workflow?
|
|
||
| - name: Create Issue From File | ||
| if: env.lychee_exit_code != 0 | ||
| uses: diffusers/create-issue-from-file@v4 |
There was a problem hiding this comment.
And where does this workflow live within diffusers?
| uses: diffusers/create-issue-from-file@v4 | ||
| with: | ||
| title: Link Checker Report | ||
| content-filepath: ./lychee/out.md |
There was a problem hiding this comment.
Would it automatically create the lychee directory?
| CI_SLACK_BOT_TOKEN: ${{ secrets.CI_SLACK_BOT_TOKEN }} | ||
| CI_SLACK_CHANNEL_ID: ${{ secrets.CI_SLACK_CHANNEL_ID_DAILY_DOCS }} | ||
| CI_SLACK_CHANNEL_ID_DAILY: ${{ secrets.CI_SLACK_CHANNEL_ID_DAILY_DOCS }} | ||
| CI_SLACK_CHANNEL_DUMMY_TESTS: ${{ secrets.CI_SLACK_CHANNEL_DUMMY_TESTS }} |
There was a problem hiding this comment.
Do we need to be informed about the dummy tests?
| CI_SLACK_CHANNEL_ID: ${{ secrets.CI_SLACK_CHANNEL_ID_DAILY_DOCS }} | ||
| CI_SLACK_CHANNEL_ID_DAILY: ${{ secrets.CI_SLACK_CHANNEL_ID_DAILY_DOCS }} |
There was a problem hiding this comment.
Just ensuring if we have configured the channels already?
| from .utils import is_pytest_available | ||
|
|
||
|
|
||
| if is_pytest_available(): |
There was a problem hiding this comment.
Should this be under tests instead?
Co-authored-by: Sayak Paul <[email protected]>
|
This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread. Please note that issues that do not follow the contributing guidelines are likely to be ignored. |
|
This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread. Please note that issues that do not follow the contributing guidelines are likely to be ignored. |
|
This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread. Please note that issues that do not follow the contributing guidelines are likely to be ignored. |
|
gentle pin @DN6 |
|
This should be revived IMO. |
|
The core issue was that the examples in our docs run full inference so the the tests would take a very long time to complete. We could skip them but then this test would not be as effective. I'll pick it back up to see if there's a better way to run examples. |
|
This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread. Please note that issues that do not follow the contributing guidelines are likely to be ignored. |
What does this PR do?
Made some updates to the original PR: #5853
Doc pages that are not tested include
There are likely more candidates that could be excluded from testing, but let's let the doctest CI run, and then determine which tests are taking too long/can be optimized.
Fixes # (issue)
Before submitting
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.