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.

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

merged 9 commits into from
Apr 8, 2024

Conversation

mfuntowicz
Copy link
Member

No description provided.

@mfuntowicz mfuntowicz requested review from tengomucho and regisss April 7, 2024 22:12
@mfuntowicz mfuntowicz added the documentation Improvements or additions to documentation label Apr 7, 2024
Copy link
Collaborator

@tengomucho tengomucho left a comment

Choose a reason for hiding this comment

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

Maybe we could add a line on how to launch an example on the TPU?


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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

for now it's mainly targeting inference... should we mention that?


## Installation

Optimum TPU is meant to reduce as much as possible the friction in order to get started.
Copy link
Collaborator

Choose a reason for hiding this comment

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

what do you mean by this?

@@ -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.

@tengomucho tengomucho merged commit f92066c into main Apr 8, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants