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

Adding architecture document #2044

Merged
merged 4 commits into from
Jun 14, 2024
Merged

Adding architecture document #2044

merged 4 commits into from
Jun 14, 2024

Conversation

tengomucho
Copy link
Contributor

What does this PR do?

Added a document (visible here) that aims at explaining the relationship between the TGI components. This can be used to better understand TGI architecture and provide a documentation for someone who might want to implement or improve a solution deployed on a hardware different from the ones that are already supported. It can be also used as base of a reflection on choices for future design changes.

Who can review?

@OlivierDehaene @Narsil

@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.

Copy link
Collaborator

@drbh drbh left a comment

Choose a reason for hiding this comment

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

Thank you @tengomucho! LGTM

@drbh drbh merged commit 445f313 into main Jun 14, 2024
2 checks passed
@drbh drbh deleted the architecture-doc branch June 14, 2024 13:28
@tengomucho
Copy link
Contributor Author

@drbh Thanks for removing the cargo lock file, I added it by mistake.
I saw the rendering is good in github.com, but not in the docs 😐 https://moon-ci-docs.huggingface.co/docs/text-generation-inference/pr_2044/en/architecture
Do you know if something can be done to fix that?

@drbh
Copy link
Collaborator

drbh commented Jun 14, 2024

no worries at all, thanks for the additional docs. I can see them in production here: https://huggingface.co/docs/text-generation-inference/architecture, can you see them there as well?

I think the link shared above is from moon-ci and may just be temporary and may have been deleted with the branch

sorry I think I misunderstood your comment! I see that the mermaid docs are not rended. I think we'd need to add support for mermaid compilation (built into github) to the doc builder, and I'm not 100% how much effort that is at the moment. A short term solution is to render them to PNG for now...

ps: added a feature request here: huggingface/doc-builder#509

@Narsil Narsil mentioned this pull request Jun 24, 2024
5 tasks
yuanwu2017 pushed a commit to yuanwu2017/tgi-gaudi that referenced this pull request Sep 26, 2024
* doc: adding architecture document

* doc: add architecture to toctree

* fix: avoid cargo lock changes

* fix: avoid cargo lock tweak

---------

Co-authored-by: drbh <david.richard.holtz@gmail.com>
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