diff --git a/.github/workflows/build_main_documentation.yml b/.github/workflows/build_main_documentation.yml index 3f8c230a98..f25ee611f6 100644 --- a/.github/workflows/build_main_documentation.yml +++ b/.github/workflows/build_main_documentation.yml @@ -49,6 +49,11 @@ jobs: repository: 'huggingface/optimum-amd' path: optimum-amd + - uses: actions/checkout@v2 + with: + repository: 'huggingface/optimum-tpu' + path: optimum-tpu + - name: Free disk space run: | df -h @@ -150,6 +155,16 @@ jobs: mv furiosa-doc-build ../optimum cd .. + - name: Make TPU documentation + run: | + sudo docker system prune -a -f + cd optimum-tpu + pip install -U pip + pip install . + doc-builder build optimum.tpu docs/source/ --build_dir tpu-doc-build --version pr_$PR_NUMBER --version_tag_suffix "" --html --clean + mv tpu-doc-build ../optimum + cd .. + - name: Make AMD documentation run: | sudo docker system prune -a -f @@ -171,7 +186,7 @@ jobs: - name: Combine subpackage documentation run: | cd optimum - sudo python docs/combine_docs.py --subpackages nvidia amd intel neuron habana furiosa --version ${{ env.VERSION }} + sudo python docs/combine_docs.py --subpackages nvidia amd intel neuron tpu habana furiosa --version ${{ env.VERSION }} cd .. - name: Push to repositories diff --git a/.github/workflows/build_pr_documentation.yml b/.github/workflows/build_pr_documentation.yml index 01d4c4e7a4..c1fc4d859c 100644 --- a/.github/workflows/build_pr_documentation.yml +++ b/.github/workflows/build_pr_documentation.yml @@ -53,6 +53,11 @@ jobs: repository: 'huggingface/optimum-amd' path: optimum-amd + - uses: actions/checkout@v2 + with: + repository: 'huggingface/optimum-tpu' + path: optimum-tpu + - name: Setup environment run: | pip uninstall -y doc-builder @@ -91,6 +96,16 @@ jobs: sudo mv amd-doc-build ../optimum cd .. + - name: Make TPU documentation + run: | + sudo docker system prune -a -f + cd optimum-tpu + pip install -U pip + pip install . + doc-builder build optimum.tpu docs/source/ --build_dir tpu-doc-build --version pr_$PR_NUMBER --version_tag_suffix "" --html --clean + mv tpu-doc-build ../optimum + cd .. + - name: Make Optimum documentation run: | sudo docker system prune -a -f @@ -101,7 +116,7 @@ jobs: - name: Combine subpackage documentation run: | cd optimum - sudo python docs/combine_docs.py --subpackages nvidia amd intel neuron habana furiosa --version pr_$PR_NUMBER + sudo python docs/combine_docs.py --subpackages nvidia amd intel neuron tpu habana furiosa --version pr_$PR_NUMBER sudo mv optimum-doc-build ../ cd .. diff --git a/docs/combine_docs.py b/docs/combine_docs.py index 17d99a3a02..e01c6c83e8 100755 --- a/docs/combine_docs.py +++ b/docs/combine_docs.py @@ -108,6 +108,31 @@ def add_neuron_doc(base_toc: List): ) +def add_tpu_doc(base_toc: List): + """ + Extends the table of content with a section about Optimum TPU. + + Args: + base_toc (List): table of content for the doc of Optimum. + """ + # Update optimum table of contents + base_toc.insert( + SUBPACKAGE_TOC_INSERT_INDEX, + { + "sections": [ + { + # Ideally this should directly point at https://huggingface.co/docs/optimum-tpu/index + # Current hacky solution is to have a redirection in _redirects.yml + "local": "docs/optimum-tpu/index", + "title": "🤗 Optimum-TPU", + } + ], + "title": "Google TPUs", + "isExpanded": False, + }, + ) + + def main(): args = parser.parse_args() optimum_path = Path("optimum-doc-build") @@ -121,6 +146,9 @@ def main(): if subpackage == "neuron": # Neuron has its own doc so it is managed differently add_neuron_doc(base_toc) + elif subpackage == "tpu": + # Optimum TPU has its own doc so it is managed differently + add_tpu_doc(base_toc) elif subpackage == "nvidia": # At the moment, Optimum Nvidia's doc is the README of the GitHub repo # It is linked to in optimum/docs/source/nvidia_overview.mdx diff --git a/docs/source/_redirects.yml b/docs/source/_redirects.yml index e3bfc0f93b..9ad8becb84 100644 --- a/docs/source/_redirects.yml +++ b/docs/source/_redirects.yml @@ -28,3 +28,6 @@ intel_trainer: intel/reference_inc # Optimum Neuron docs/optimum-neuron/index: /docs/optimum-neuron/index + +# Optimum TPU +docs/optimum-tpu/index: /docs/optimum-tpu/index diff --git a/docs/source/index.mdx b/docs/source/index.mdx index 4e61e960d5..7eb79c33ed 100644 --- a/docs/source/index.mdx +++ b/docs/source/index.mdx @@ -25,7 +25,7 @@ As such, Optimum enables developers to efficiently use any of these platforms wi The packages below enable you to get the best of the 🤗 Hugging Face ecosystem on various types of devices.
-
+