Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to the repository #13

Merged
merged 9 commits into from
Apr 8, 2024
Merged

Add documentation to the repository #13

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
17e0725
Initial commit for the documentation
mfuntowicz Apr 5, 2024
83433a5
Initial doc-build workflow
mfuntowicz Apr 7, 2024
340565d
Initial how to deploy instance
mfuntowicz Apr 7, 2024
869526a
Add the gcloud alpha requirement
mfuntowicz Apr 7, 2024
23ac653
Address general comments
mfuntowicz Apr 8, 2024
ea8fa00
Add PR doc workflows
regisss Apr 8, 2024
f6446b1
Fix workflow
regisss Apr 8, 2024
4abc47c
Add _toctree
regisss Apr 8, 2024
e86a4a7
Fix docs/source/howto/overview
regisss Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/source/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,14 @@ 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 training and inference.
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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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! 🚀


## Installation

Optimum TPU is meant to reduce as much as possible the friction in order to get started.
Optimum TPU is meant to reduce as much as possible the friction in order to leverage Google Cloud TPU accelerators.
As such, we provide a pip installable package to make sure everyone can get easily started.

### Run Cloud TPU with pip
Expand Down