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

docs: Re-structure User Guides for Discoverability #7807

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

statiraju
Copy link

Thanks for submitting a PR to Triton!
Please go the the Preview tab above this description box and select the appropriate sub-template:

If you already created the PR, please replace this message with one of

and fill it out.

docs/conf.py Dismissed Show dismissed Hide dismissed

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_css_files = ["custom.css"]
#html_css_files = ["custom.css"] # Not needed with new theme
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#html_css_files = ["custom.css"] # Not needed with new theme

Comment on lines +158 to +159
#"json_url": "https://docs.nvidia.com/deeplearning/triton-inference-server/user-guide/"
#"docs/_static/switcher.json",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#"json_url": "https://docs.nvidia.com/deeplearning/triton-inference-server/user-guide/"
#"docs/_static/switcher.json",

@@ -31,7 +31,7 @@
Clients can communicate with Triton using either an [HTTP/REST
protocol](#httprest-and-grpc-protocols), a [GRPC
protocol](#httprest-and-grpc-protocols), or by an [in-process C
API](#in-process-triton-server-api) or its
API](inprocess_c_api.md#in-process-triton-server-api) or its
Copy link
Contributor

Choose a reason for hiding this comment

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

update copyrights

Comment on lines +4 to +14
"url": "https://docs.nvidia.com/deeplearning/triton-inference-server/user-guide/docs/"
},
{
"name": "2.50 (stable)",
"version": "2.50",
"url": "https://docs.nvidia.com/deeplearning/triton-inference-server/user-guide/docs/"
},
{
"name": "2.49",
"version": "2.49",
"url": "https://docs.nvidia.com/deeplearning/triton-inference-server/user-guide/docs/"
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we have different urls available for each version?

@rmccorm4 rmccorm4 changed the title Update Triton Userguides docs: Re-structure User Guides for Discoverability Nov 18, 2024
@@ -0,0 +1,10 @@
########
State Management
Copy link
Contributor

@rmccorm4 rmccorm4 Nov 19, 2024

Choose a reason for hiding this comment

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

On the rendering, the State Management section feels unnecessarily nested. It's a single indirection to the Implicit State Management page with no other info/links.

Maybe the State Management tab/page can also provide a link to the (1) Sequence Batch Scheduler and (2) Stateful Model sections/docs?

State Management
- Stateful Models (link)
- Implicit State Management (link)
- Sequence Batch Scheduler (link)

Comment on lines +11 to +12
Scheduler <../user_guide/scheduler.md>
Batcher <../user_guide/batcher.md>
Copy link
Contributor

@rmccorm4 rmccorm4 Nov 19, 2024

Choose a reason for hiding this comment

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

I think these could probably be joined into one Scheduling & Batching section

Scheduling & Batching
- Default Scheduler
- Ensemble Scheduler
- Dynamic Batch Scheduler
- Sequence Batch Scheduler
- Custom Batching Strategies

![Triton Mult-Model Parallel Execution
Diagram](images/multi_model_parallel_exec.png)

# Models And Schedulers
Copy link
Contributor

@rmccorm4 rmccorm4 Nov 19, 2024

Choose a reason for hiding this comment

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

This Model Execution doc feels a bit strange. The concurrent execution section at the top makes sense, but the following sections on schedulers, stateless, control inputs, etc. feel like they don't belong in the same category/doc.

@statiraju statiraju requested a review from mc-nv December 2, 2024 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants