Skip to content

Commit fa5d9c2

Browse files
guangy10Guang Yang
andauthored
[doc] Link Hugging Face models to the ExecuTorch doc (#10154)
### Summary ExecuTorch doc and repo have been successfully linked to the main entry on [Hugging Face doc](https://huggingface.co/docs/optimum/main/en/index), now we need to link the Hugging Face doc and repo ([`huggingface/optimum-executorch`](https://github.com/huggingface/optimum-executorch)) to ExecuTorch doc for seamless experience. ### Test plan Doc build on CI Co-authored-by: Guang Yang <[email protected]>
1 parent b164db7 commit fa5d9c2

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/source/getting-started.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ ExecuTorch provides hardware acceleration for a wide variety of hardware. The mo
4343
For mobile use cases, consider using XNNPACK for Android and Core ML or XNNPACK for iOS as a first step. See [Hardware Backends](backends-overview.md) for more information.
4444

4545
### Exporting
46-
Exporting is done using Python APIs. ExecuTorch provides a high degree of customization during the export process, but the typical flow is as follows. This example uses the MobileNet V2 image classification model implementation in torchvision, but the process supports any [export-compliant](https://pytorch.org/docs/stable/export.html) PyTorch model.
46+
Exporting is done using Python APIs. ExecuTorch provides a high degree of customization during the export process, but the typical flow is as follows. This example uses the MobileNet V2 image classification model implementation in torchvision, but the process supports any [export-compliant](https://pytorch.org/docs/stable/export.html) PyTorch model. For users working with Hugging Face models,
47+
you can find a list of supported models in the [*huggingface/optimum-executorch*](https://github.com/huggingface/optimum-executorch) repo.
4748

4849
```python
4950
import torch
@@ -101,6 +102,8 @@ print(torch.allclose(output[0], eager_reference_output, rtol=1e-3, atol=1e-5))
101102

102103
For complete examples of exporting and running the model, please refer to our [examples GitHub repository](https://github.com/pytorch-labs/executorch-examples/tree/main/mv2/python).
103104

105+
Additionally, if you work with Hugging Face models, the [*huggingface/optimum-executorch*](https://github.com/huggingface/optimum-executorch) library simplifies running these models end-to-end with ExecuTorch, using familiar Hugging Face APIs. Visit the repository for specific examples and supported models.
106+
104107
<hr/>
105108

106109
## Running on Device

docs/source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ ExecuTorch provides support for:
4343
#### Examples
4444
- [Android Demo Apps](https://github.com/pytorch-labs/executorch-examples/tree/main/dl3/android/DeepLabV3Demo#executorch-android-demo-app)
4545
- [iOS Demo Apps](demo-apps-ios.md)
46+
- [Hugging Face Models](https://github.com/huggingface/optimum-executorch/blob/main/README.md)
4647
#### Backends
4748
- [Overview](backends-overview)
4849
- [XNNPACK](backends-xnnpack)

0 commit comments

Comments
 (0)