-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Conversation
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. |
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.
Thank you @tengomucho! LGTM
@drbh Thanks for removing the cargo lock file, I added it by mistake. |
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 |
* 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>
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