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 some initial docs content and diagrams #129

Merged
merged 4 commits into from
Jan 13, 2025

Conversation

robscott
Copy link
Member

Initial WIP attempt of some content for our docs.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 21, 2024
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 21, 2024
@kfswain
Copy link
Collaborator

kfswain commented Dec 21, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 21, 2024
site-src/index.md Show resolved Hide resolved
site-src/index.md Outdated Show resolved Hide resolved
site-src/index.md Outdated Show resolved Hide resolved
[vLLM](https://github.com/vllm-project/vllm) and
[Triton](https://github.com/triton-inference-server/server), and will be open to
other integrations as they are requested.
Copy link
Contributor

Choose a reason for hiding this comment

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

@liu-cong will create a page for the model server protocol. @liu-cong we can start with the narrowest set of requirements: kv-cache, active adapters and queue length; the metric type of each for both Prometheus and ORCA formats.

@ahg-g
Copy link
Contributor

ahg-g commented Dec 21, 2024

Part of #72

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 30, 2024
Copy link
Contributor

@danehans danehans left a comment

Choose a reason for hiding this comment

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

A few nits, otherwise /LGTM.

processor:
ignoreTypes:
- "(InferencePool|InferenceModel)List$"
# RE2 regular expressions describing type fields that should be excluded from the generated documentation.
Copy link
Contributor

Choose a reason for hiding this comment

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

RE2?

Copy link
Member Author

Choose a reason for hiding this comment

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

Just a specific flavor of regex: https://github.com/google/re2/wiki/syntax - this is copied from the sample config file for crd-ref-docs

crd-ref-docs.yaml Show resolved Hide resolved
site-src/concepts/conformance.md Outdated Show resolved Hide resolved

The overall resource model focuses on 2 new inference-focused
[personas](/concepts/roles-and-personas) and corresponding resources that
Copy link
Contributor

Choose a reason for hiding this comment

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

Note that roles-and-personas.md is in a TODO state.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I'm just trying to get something WIP in and then hopefully it's easier to split up the remaining docs into smaller PRs by more people.

site-src/index.md Outdated Show resolved Hide resolved
site-src/index.md Outdated Show resolved Hide resolved
site-src/index.md Outdated Show resolved Hide resolved
site-src/index.md Outdated Show resolved Hide resolved
@kfswain
Copy link
Collaborator

kfswain commented Jan 13, 2025

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 13, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: danehans, kfswain, robscott

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 13, 2025
@k8s-ci-robot k8s-ci-robot merged commit 0503318 into kubernetes-sigs:main Jan 13, 2025
4 checks passed
kfswain pushed a commit to kfswain/llm-instance-gateway that referenced this pull request Jan 15, 2025
* Adding some initial docs content and diagrams

* Adding FAQ, contributing, and implementations pages

* Adding generated API docs + basic API docs and diagram

* Cleanup from PR feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants