[ORT Training] Some important updates of ONNX Runtime training APIs #3938
Workflow file for this run
This file contains 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 | |
| # WARNING: As this workflow supports the pull_request_target event, please exercise extra care when editing it. | |
| on: | |
| workflow_dispatch: | |
| pull_request_target: | |
| branches: [ main ] | |
| types: [ opened, synchronize, reopened, labeled ] | |
| paths: | |
| - "optimum/**.py" | |
| - "docs/**.mdx" | |
| - "docs/**.yml" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| authorize: | |
| if: (github.event.action == 'labeled' && github.event.label.name == 'build-pr-doc') || github.event_name != 'pull_request_target' || (! github.event.pull_request.head.repo.fork) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - run: true | |
| build_documentation: | |
| needs: authorize | |
| runs-on: ubuntu-latest | |
| 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/checkout@v2 | |
| with: | |
| repository: 'huggingface/doc-builder' | |
| path: doc-builder | |
| - uses: actions/checkout@v2 | |
| with: | |
| repository: 'huggingface/optimum' | |
| path: optimum | |
| ref: ${{ github.event.pull_request.merge_commit_sha }} | |
| - uses: actions/checkout@v2 | |
| with: | |
| repository: 'huggingface/optimum-habana' | |
| path: optimum-habana | |
| - uses: actions/checkout@v2 | |
| with: | |
| repository: 'huggingface/optimum-graphcore' | |
| path: optimum-graphcore | |
| - uses: actions/checkout@v2 | |
| with: | |
| repository: 'huggingface/optimum-intel' | |
| path: optimum-intel | |
| - uses: actions/checkout@v2 | |
| with: | |
| repository: 'huggingface/optimum-furiosa' | |
| path: optimum-furiosa | |
| - name: Setup environment | |
| run: | | |
| pip uninstall -y doc-builder | |
| cd doc-builder | |
| git pull origin main | |
| pip install . | |
| pip install black | |
| cd .. | |
| - name: Make Graphcore documentation | |
| run: | | |
| cd optimum-graphcore | |
| make doc BUILD_DIR=graphcore-doc-build VERSION=pr_$PR_NUMBER | |
| sudo mv graphcore-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 Intel documentation | |
| run: | | |
| sudo docker system prune -a -f | |
| cd optimum-intel | |
| make doc BUILD_DIR=intel-doc-build VERSION=pr_$PR_NUMBER | |
| sudo mv intel-doc-build ../optimum | |
| cd .. | |
| - name: Make Furiosa documentation | |
| run: | | |
| cd optimum-furiosa | |
| pip install . | |
| sudo apt update | |
| sudo apt install -y ca-certificates apt-transport-https gnupg | |
| sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-key 5F03AFA423A751913F249259814F888B20B09A7E | |
| # TODO: remove secrets and pull_request_target once archive.furiosa.ai is public | |
| sudo tee -a /etc/apt/auth.conf.d/furiosa.conf > /dev/null <<EOT | |
| machine archive.furiosa.ai | |
| login ${{ secrets.FURIOSA_ACCESS_KEY }} | |
| password ${{ secrets.FURIOSA_SECRET_ACCESS_KEY }} | |
| EOT | |
| sudo chmod 400 /etc/apt/auth.conf.d/furiosa.conf | |
| sudo tee -a /etc/apt/sources.list.d/furiosa.list <<EOT | |
| deb [arch=amd64] https://archive.furiosa.ai/ubuntu jammy restricted | |
| EOT | |
| sudo apt update && sudo apt install -y furiosa-libnux | |
| doc-builder build optimum.furiosa docs/source/ --build_dir furiosa-doc-build --version pr_$PR_NUMBER --version_tag_suffix "" --html --clean | |
| mv furiosa-doc-build ../optimum | |
| cd .. | |
| - name: Make Optimum documentation | |
| run: | | |
| sudo docker system prune -a -f | |
| cd optimum | |
| make doc BUILD_DIR=optimum-doc-build VERSION=pr_$PR_NUMBER COMMIT_SHA_OPTIMUM=$COMMIT_SHA CLONE_URL=$PR_CLONE_URL | |
| cd .. | |
| - name: Combine subpackage documentation | |
| run: | | |
| cd optimum | |
| sudo python docs/combine_docs.py --subpackages graphcore habana intel neuron furiosa --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@v3 | |
| with: | |
| name: doc-build-artifact | |
| path: optimum-doc-build/ |