Skip to content

Add doc test CI workflow reusing existing model job infrastructure#45189

Open
ydshieh wants to merge 8 commits intomainfrom
new_doctest_workflow
Open

Add doc test CI workflow reusing existing model job infrastructure#45189
ydshieh wants to merge 8 commits intomainfrom
new_doctest_workflow

Conversation

@ydshieh
Copy link
Copy Markdown
Collaborator

@ydshieh ydshieh commented Apr 2, 2026

Summary

  • Add two optional, backward-compatible inputs (test_path_prefix, test_file_suffix) to model_jobs.yml and self-scheduled.yml — defaults preserve all existing behavior
  • Extend the set-matrix step in self-scheduled.yml to discover runnable doc examples (files containing ```py runnable) when test_file_suffix is set, emitting one single-element slice per model so each model's doc tests run in a separate parallel job
  • Add self-doc-scheduled-caller.yml — a new daily caller that passes job: run_models_gpu with test_path_prefix: docs/source/en/model_doc and test_file_suffix: .md, reusing all existing Slack reporting, failure checking, and artifact infrastructure from self-scheduled.yml without duplicating any workflow files

Test plan

  • Trigger manually via workflow_dispatch on self-doc-scheduled-caller.yml
  • Or push to a branch matching run_doc_tests* to trigger the caller
  • Verify one job per model doc file is spawned in the run_models_gpu matrix
  • Verify existing model CI (self-scheduled-caller.yml) is unaffected (all new inputs are optional with defaults)

🤖 Generated with Claude Code

- Add `test_path_prefix` and `test_file_suffix` optional inputs to `model_jobs.yml` and `self-scheduled.yml` (backward-compatible, defaults preserve existing behavior)
- Extend `set-matrix` in `self-scheduled.yml` to discover runnable doc examples when `test_file_suffix` is set, emitting one slice per model for full parallelism
- Add `self-doc-scheduled-caller.yml` to run doc tests daily, reusing `run_models_gpu` + all existing Slack/failure-check infrastructure

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

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.

ydshieh and others added 7 commits April 2, 2026 16:18
Add optional `machine_types` input (JSON array string) to `self-scheduled.yml`,
defaulting to both machine types to preserve existing behavior. Doc test caller
passes `["aws-g5-4xlarge-cache"]` to run only on single-gpu.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

2 participants