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.

Sign up for GitHub

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

Jump to bottom

Adding some initial docs content and diagrams #129

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

Adding some initial docs content and diagrams #129

wants to merge 4 commits into from

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
ahg-g
ahg-g reviewed Dec 21, 2024
View reviewed changes
site-src/index.md
Gateway API has [more than 25
implementations](https://gateway-api.sigs.k8s.io/implementations/). As this
pattern stabilizes, we expect a wide set of these implementations to support
Copy link
Contributor

Choose a reason for hiding this comment

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

not clear what pattern this refers to, perhaps we should say the word pattern in the composable layer section intro so that the reader can connect the dots

site-src/index.md Outdated Show resolved Hide resolved
site-src/index.md Outdated Show resolved Hide resolved
site-src/index.md
[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 ahg-g mentioned this pull request Dec 21, 2024
Open
@ahg-g
Copy link
Contributor

ahg-g commented Dec 21, 2024

Part of #72

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 30, 2024
@k8s-ci-robot
Copy link
Contributor

New changes are detected. LGTM label has been removed.

@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 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
@robscott robscott mentioned this pull request Jan 3, 2025
Open
danehans
danehans approved these changes Jan 6, 2025
View reviewed changes
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.

crd-ref-docs.yaml
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
site-src/index.md

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
@robscott robscott mentioned this pull request Jan 10, 2025
Open
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: danehans, robscott
Once this PR has been reviewed and has the lgtm label, please ask for approval from kfswain. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ahg-g ahg-g ahg-g left review comments

@danehans danehans danehans approved these changes

@kfswain kfswain Awaiting requested review from kfswain

@liu-cong liu-cong Awaiting requested review from liu-cong

Assignees

@kfswain kfswain

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@robscott @kfswain @ahg-g @k8s-ci-robot @danehans