Skip to content

Add executorch documentation section#2193

Merged
echarlaix merged 1 commit into
mainfrom
doc-executorch
Mar 7, 2025
Merged

Add executorch documentation section#2193
echarlaix merged 1 commit into
mainfrom
doc-executorch

Conversation

@echarlaix

@echarlaix echarlaix commented Feb 20, 2025

Copy link
Copy Markdown
Collaborator

Can be merged once executorch documentation is generated huggingface/optimum-executorch#21

Also a section can be added in https://github.com/huggingface/optimum/blob/v1.24.0/docs/source/index.mdx?plain=1#L60 after the first release of optimum-executorch

Fixes huggingface/optimum-executorch#2

@echarlaix
echarlaix requested a review from regisss February 20, 2025 11:30
@echarlaix
echarlaix marked this pull request as ready for review February 20, 2025 11:30
@echarlaix echarlaix changed the title Add executorch section Add executorch documentation section Feb 20, 2025
@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.

@guangy10

Copy link
Copy Markdown
Contributor

@echarlaix Thanks for bringing the doc back. Lots of users were asking about this!

I'm also very excited about the first release! What is the timeline and do you have particular things in mind that we should include in the first release? To me I feel we should probably include implementation of save_pretrained, push_to_hub, etc. so that users will have a complete story of distribute the pte artifacts through HF. Besides that, I'd like to get more models covered, that's something I'm looking into, but this can be optional. wdyt?

@guangy10 guangy10 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@guangy10

Copy link
Copy Markdown
Contributor

@echarlaix Where are we going to list the supported models? Don't see that page is ported over from the original PR: d21256c#diff-203c8cf6d5e8aa8a958f2fbe209e15c840dbbedf1d8f6afb2f31e55046d28d75. We could include Deepseek-R1 (Llama based), and SmolLM2

@regisss regisss left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!

@guangy10

Copy link
Copy Markdown
Contributor

@echarlaix Is there a time to merge this PR? We are currently hold sharing it broadly because of the user experience. With the documentation, users won't know explicit what is working and what is not, and they have been asking this in our discord channel. I cc'd you on some thoughts above about features we need to have in the 1st release. wdyt?

@echarlaix

echarlaix commented Mar 6, 2025

Copy link
Copy Markdown
Collaborator Author

@echarlaix
echarlaix merged commit 3adbe7c into main Mar 7, 2025
@echarlaix
echarlaix deleted the doc-executorch branch March 7, 2025 15:22
@echarlaix

Copy link
Copy Markdown
Collaborator Author

@guangy10 the executorch documentation can be found in here, will also be part of the optimum documentation under the ExecuTorch section (currently main documentation is not pushed correctly but this is not related)

image

@guangy10

guangy10 commented Mar 7, 2025

Copy link
Copy Markdown
Contributor

@guangy10 the executorch documentation can be found in here, will also be part of the optimum documentation under the ExecuTorch section (currently main documentation is not pushed correctly but this is not related)

image

Thanks @echarlaix I added this to the bugbash as well for folks to test and review

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.

ExecuTorch documentation is broken on Hub

4 participants