Skip to content

Commit

Permalink
Fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
regisss committed Apr 8, 2024
1 parent 83378dc commit 7efe79d
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
1 change: 1 addition & 0 deletions docs/source/howto/serving.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Stay tuned!
22 changes: 13 additions & 9 deletions docs/source/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ limitations under the License.

Optimum TPU provides all the necessary machinery to leverage and optimize AI workloads runningo on [Google Cloud TPU devices](https://cloud.google.com/tpu/docs).

The API provides the overall same user-experience as Hugging Face transformers with the minimum amount of changes required to target performance for both inference.
The API provides the overall same user-experience as Hugging Face transformers with the minimum amount of changes required to target performance for inference.

Training support is underway, stay tuned! 🚀

Expand Down Expand Up @@ -48,22 +48,26 @@ From there you can install optimum-tpu through the pip instructions above.

<div class="mt-10">
<div class="w-full flex flex-col space-y-4 md:space-y-0 md:grid md:grid-cols-2 md:gap-y-4 md:gap-x-5">
<a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg" href="./howto/overview">
<div class="w-full text-center bg-gradient-to-br from-red-500 to-red-800 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">
How-to guides
<a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg" href="./tutorials/overview">
<div class="w-full text-center bg-gradient-to-br from-red-400 to-red-500 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">
Tutorials
</div>
<p class="text-gray-700">

Learn the basics and become familiar with deploying transformers on Google TPUs.
Start here if you are using 🤗 Optimum-TPU for the first time!
</p>
</a>
<a
class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg"
href="./package_reference/trainer"
href="./howto/overview"
>
<div class="w-full text-center bg-gradient-to-br from-green-500 to-green-800 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">
Reference
<div class="w-full text-center bg-gradient-to-br from-green-500 to-green-600 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">
How-to guides
</div>
<p class="text-gray-700">Technical descriptions of how the classes and methods of Optimum TPU</p>
<p class="text-gray-700">
Practical guides to help you achieve a specific goal. Take a look at these guides to learn how to use 🤗 Optimum-TPU
to solve real-world problems.
</p>
</a>
</div>
</div>
1 change: 1 addition & 0 deletions docs/source/tutorials/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Welcome to the 🤗 Optimum-TPU tutorials!

0 comments on commit 7efe79d

Please sign in to comment.