-
Notifications
You must be signed in to change notification settings - Fork 238
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 related docs for intel cpu/xpu/hpu container #550
Conversation
@regisss @Narsil @baptistecolle Hi, pls help review, thx! |
Signed-off-by: Liu, Kaixuan <[email protected]>
…1.5` Signed-off-by: Liu, Kaixuan <[email protected]>
Signed-off-by: Liu, Kaixuan <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don’t think modifying the custom_container.md
or quick_tour.md
files is the best approach for adding documentation on Intel CPU/XPU/HPU.
It would be more effective to create a new page, local_intel.md
, with a title like Using TEI on Intel Hardware, where all the relevant information about CPU/XPU/HPU can be included. You can refer to local_metal.md
, local_cpu.md
, and local_gpu.md
for inspiration and adapt them for Intel. I’d suggest having three sections—one for each device—detailing how to start the container. Additionally, it makes sense to also include a link to the Docker image, so users don’t have to necessarily manually build it but can pull the image directly from GHCR.
Good advice! I have moved the content into a separate doc file following your advice. |
Signed-off-by: Liu, Kaixuan <[email protected]>
Signed-off-by: Liu, Kaixuan <[email protected]>
Signed-off-by: Liu, Kaixuan <[email protected]>
Signed-off-by: Liu, Kaixuan <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new page looks great! The only thing left is to link it in the doc_tree, so it becomes visible: https://github.com/huggingface/text-embeddings-inference/blob/main/docs/source/en/_toctree.yml
@baptistecolle Is it OK? |
Signed-off-by: Liu, Kaixuan <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! thanks for the changes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect ! Let's merge.
@baptistecolle feel free to merge when everything is green btw.
No description provided.