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

Ipex doc #828

Merged
merged 32 commits into from
Aug 27, 2024
Merged

Ipex doc #828

merged 32 commits into from
Aug 27, 2024

Conversation

jiqing-feng
Copy link
Collaborator

@jiqing-feng jiqing-feng commented Jul 17, 2024

Hi @echarlaix . I just noticed that we haven't got any ipex doc on huggingface doc hub.

This is the 1st step that enables the optimmu-cli command to export models.

I will add ipex doc in the next step (in this PR), please review the optimmu-cli command for ipex. Thx!

@jiqing-feng
Copy link
Collaborator Author

All ipex docs have been added, please take a review @echarlaix

cc @rbrugaro

docs/source/_toctree.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
optimum/commands/register/register_openvino.py Outdated Show resolved Hide resolved
Co-authored-by: Ella Charlaix <80481427+echarlaix@users.noreply.github.com>
jiqing-feng and others added 2 commits July 17, 2024 16:26
Co-authored-by: Ella Charlaix <80481427+echarlaix@users.noreply.github.com>
docs/source/ipex/export.mdx Outdated Show resolved Hide resolved
optimum/commands/export/ipex.py Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@jiqing-feng
Copy link
Collaborator Author

@echarlaix Please trigger the tests. Thx.

@jiqing-feng
Copy link
Collaborator Author

Hi @echarlaix . For the IPEX doc, I have removed export and anything related to jit. It will not confuse users even we change jit.trance to torch.compile because we didn't mention it in the docs, and the user's behaviors will not be changed. We need an ipex doc to show users how to use IPEXModel and don't need to tell users the details, WDYT?

docs/source/ipex/inference.mdx Show resolved Hide resolved
docs/source/ipex/inference.mdx Outdated Show resolved Hide resolved

# Inference

Optimum Intel can be used to load models from the [Hub](https://huggingface.co/models) and create pipelines to run inference with IPEX optimization (including patching, weight prepack and graph mode) on a variety of Intel processors (currently only support for CPU)
Copy link
Collaborator

@echarlaix echarlaix Jul 25, 2024

Choose a reason for hiding this comment

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

What's the plan for the models format in the next release ? From my understanding we will stop using TorchScript, I'd prefer to wait for the next release once we have something that won't get deprecated, before adding it to the documentation

Copy link
Collaborator Author

@jiqing-feng jiqing-feng Jul 26, 2024

Choose a reason for hiding this comment

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

Do you mean the Pytorch release? If so, it depends on the models performance under torch.compile. If all models can have an acceptable speed-up under torch.compile, we will remove jit.trace and apply torch.compile; otherwise, we will keep torchscript or convert parts of models to torch.compile, I will discuss with you before I take any actions.

I don't think waiting for the next release is the best option since the torch.compile is not under our control. Currently, torch.compile is not working on all models for all tasks; many performance regressions need to be fixed. We will apply the torch.compile one by one for models. Changing all models to compile without any issues is impossible for now, so it's a long-term project. Besides, we will not change the API in IPEXModel, so it's okay to deliver this ipex doc to users.

docs/source/ipex/inference.mdx Outdated Show resolved Hide resolved
docs/source/ipex/inference.mdx Outdated Show resolved Hide resolved
jiqing-feng and others added 3 commits July 29, 2024 08:51
Co-authored-by: Ella Charlaix <80481427+echarlaix@users.noreply.github.com>
@jiqing-feng
Copy link
Collaborator Author

Hi @echarlaix . Do you think this PR could be merged since all tests passed?

@HuggingFaceDocBuilderDev

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.

docs/source/index.mdx Outdated Show resolved Hide resolved
docs/Dockerfile Outdated Show resolved Hide resolved
docs/source/ipex/models.mdx Outdated Show resolved Hide resolved
docs/source/ipex/inference.mdx Outdated Show resolved Hide resolved
docs/source/ipex/inference.mdx Outdated Show resolved Hide resolved
docs/source/ipex/inference.mdx Outdated Show resolved Hide resolved
docs/source/ipex/inference.mdx Outdated Show resolved Hide resolved
@echarlaix echarlaix merged commit 403c696 into huggingface:main Aug 27, 2024
17 checks passed
@jiqing-feng jiqing-feng mentioned this pull request Aug 28, 2024
@jiqing-feng jiqing-feng deleted the ipex_doc branch August 28, 2024 06:59
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