Optimum pipelines #5846
Workflow file for this run
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
| name: Build PR documentation | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - "optimum/**.py" | |
| - "docs/**.mdx" | |
| - "docs/**.yml" | |
| - ".github/workflows/build_pr_documentation.yml" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| env: | |
| UV_SYSTEM_PYTHON: 1 | |
| UV_TORCH_BACKEND: auto | |
| jobs: | |
| build_documentation: | |
| runs-on: ubuntu-22.04 | |
| env: | |
| COMMIT_SHA: ${{ github.event.pull_request.head.sha }} | |
| PR_NUMBER: ${{ github.event.number }} | |
| EVENT_CONTEXT: ${{ toJSON(github.event) }} | |
| PR_CLONE_URL: ${{ github.event.pull_request.head.repo.clone_url }} | |
| steps: | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: "18" | |
| cache-dependency-path: "kit/package-lock.json" | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.11" | |
| - uses: actions/checkout@v2 | |
| with: | |
| repository: "huggingface/optimum" | |
| path: optimum | |
| - uses: actions/checkout@v2 | |
| with: | |
| repository: "huggingface/optimum-habana" | |
| path: optimum-habana | |
| - uses: actions/checkout@v2 | |
| with: | |
| repository: "huggingface/optimum-intel" | |
| path: optimum-intel | |
| - uses: actions/checkout@v2 | |
| with: | |
| repository: "huggingface/optimum-amd" | |
| path: optimum-amd | |
| - name: Setup environment | |
| run: | | |
| pip install --upgrade pip uv | |
| uv pip install git+https://github.com/huggingface/doc-builder | |
| - name: Make Intel documentation | |
| run: | | |
| cd optimum-intel | |
| uv pip install . nncf openvino neural-compressor[pt]>3.4 diffusers accelerate | |
| make doc BUILD_DIR=intel-doc-build VERSION=pr_$PR_NUMBER | |
| sudo mv intel-doc-build ../optimum | |
| cd .. | |
| - name: Make Habana documentation | |
| run: | | |
| sudo docker system prune -a -f | |
| cd optimum-habana | |
| make doc BUILD_DIR=habana-doc-build VERSION=pr_$PR_NUMBER | |
| sudo mv habana-doc-build ../optimum | |
| cd .. | |
| - name: Make AMD documentation | |
| run: | | |
| sudo docker system prune -a -f | |
| cd optimum-amd | |
| make doc BUILD_DIR=amd-doc-build VERSION=pr_$PR_NUMBER | |
| sudo mv amd-doc-build ../optimum | |
| cd .. | |
| - name: Make Optimum documentation | |
| run: | | |
| cd optimum | |
| uv pip install . accelerate | |
| make doc BUILD_DIR=optimum-doc-build VERSION=pr_$PR_NUMBER | |
| cd .. | |
| - name: Combine subpackage documentation | |
| run: | | |
| cd optimum | |
| sudo python docs/combine_docs.py --subpackages nvidia amd intel neuron tpu habana furiosa executorch onnx --version pr_$PR_NUMBER | |
| sudo mv optimum-doc-build ../ | |
| cd .. | |
| - name: Save commit_sha & pr_number | |
| run: | | |
| sudo chmod -R ugo+rwx optimum-doc-build | |
| cd optimum-doc-build | |
| echo ${{ env.COMMIT_SHA }} > ./commit_sha | |
| echo ${{ env.PR_NUMBER }} > ./pr_number | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: doc-build-artifact | |
| path: optimum-doc-build/ |