Skip to content

Link Optimum-ExecuTorch to parent Optimum on Hub#2222

Merged
michaelbenayoun merged 1 commit into
huggingface:mainfrom
guangy10:doc_executorch
Apr 8, 2025
Merged

Link Optimum-ExecuTorch to parent Optimum on Hub#2222
michaelbenayoun merged 1 commit into
huggingface:mainfrom
guangy10:doc_executorch

Conversation

@guangy10

@guangy10 guangy10 commented Apr 3, 2025

Copy link
Copy Markdown
Contributor

What does this PR do?

Fix discoverability of Optimum-ExecuTorch on 🤗 from parent Optimum doc site on Hub.

Fixes # huggingface/optimum-executorch#35

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you make sure to update the documentation with your changes?

Who can review?

@echarlaix @michaelbenayoun

@guangy10
guangy10 force-pushed the doc_executorch branch 2 times, most recently from abbb06f to 2321195 Compare April 3, 2025 00:37
@guangy10

guangy10 commented Apr 3, 2025

Copy link
Copy Markdown
Contributor Author

don't seem to have permission to kickoff the CI

@HuggingFaceDocBuilderDev

Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Comment thread docs/source/index.mdx Outdated
Comment on lines +82 to +85
<a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg" href="https://huggingface.co/docs/optimum-executorch/index"
><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">ExecuTorch</div>
<p class="text-gray-700">PyTorch’s native solution to training and inference on the Edge devices <span class="underline" onclick="event.preventDefault(); window.open('https://pytorch.org/executorch/stable/', '_blank');">ExecuTorch</span></p>
</a>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think it does not make sense to put it here since we already have a square for "Exporters" which ExecuTorch belongs to.
IMO you should add a ExecuTorch section under https://moon-ci-docs.huggingface.co/docs/optimum/pr_2222/en/exporters/overview instead.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@michaelbenayoun Because I see ONNXRuntime is listed in this section. ExecuTorch is not just a exporter, torch.export is, and it's only the entry point to the ExecuTorch stack. ExecuTorch provides runtime as well, similar to ONNXRuntime, and it also provides hardware delegations and optimized kernels, etc. The inference models in optimum-executorch are using ExecuTorch runtime and its kernel libraries.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Alright makes sense. I will validate that for now, waiting for @echarlaix to be back to discuss about it.

@guangy10
guangy10 force-pushed the doc_executorch branch 3 times, most recently from 4b6ae14 to b9f0f1b Compare April 3, 2025 21:01
@guangy10

guangy10 commented Apr 3, 2025

Copy link
Copy Markdown
Contributor Author

Small tweaks on the color and texts

@michaelbenayoun
michaelbenayoun merged commit f795e82 into huggingface:main Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants