Skip to content

Commit 839d74c

Browse files
committed
docs: add concepts and defs to README.md
Signed-off-by: Shane Utt <[email protected]>
1 parent bd9ee36 commit 839d74c

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,26 @@
1-
# Gateway API Inference Extension
1+
# Gateway API Inference Extension (GIE)
2+
3+
This project offers tools for AI Inference, enabling developers to build [Inference Gateways].
4+
5+
[Inference Gateways]:#concepts-and-definitions
6+
7+
## Concepts and Definitions
8+
9+
AI/ML is changing rapidly, and [Inference] goes beyond basic networking to include complex traffic routing and optimizations. Below are key terms used within this project:
10+
11+
- **Scheduler**: Makes decisions about which endpoint is optimal (best cost / best performance) for an inference request based on `Metrics and Capabilities` from [Model Serving](/docs/proposals/003-model-server-protocol/README.md).
12+
- **Metrics and Capabilities**: Data provided by model serving platforms about performance, availability and capabilities to optimize routing. Includes things like [Prefix Cache] status or [LoRA Adapters] availability.
13+
- **Endpoint Selector**: A `Scheduler` combined with `Metrics and Capabilities` systems is often referred to together as an [Endpoint Selection Extension](https://gateway-api-inference-extension.sigs.k8s.io/#endpoint-selection-extension) (this is also sometimes referred to as an "endpoint picker").
14+
- **Inference Gateway**: A proxy/load-balancer which has been coupled with a `Endpoint Selector`. It provides optimized routing and load balancing for serving generative Artificial Intelligence (AI) workloads. It simplifies the deployment, management, and observability of AI inference workloads.
15+
16+
For deeper insights and more advanced concepts, refer to our [proposals](/docs/proposals).
17+
18+
[Inference]:https://www.digitalocean.com/community/tutorials/llm-inference-optimization
19+
[Gateway API]:https://github.com/kubernetes-sigs/gateway-api
20+
[Prefix Cache]:https://docs.vllm.ai/en/stable/design/v1/prefix_caching.html
21+
[LoRA Adapters]:https://docs.vllm.ai/en/stable/features/lora.html
22+
23+
## Technical Overview
224

325
This extension upgrades an [ext-proc](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/ext_proc_filter)-capable proxy or gateway - such as Envoy Gateway, kGateway, or the GKE Gateway - to become an **inference gateway** - supporting inference platform teams self-hosting large language models on Kubernetes. This integration makes it easy to expose and control access to your local [OpenAI-compatible chat completion endpoints](https://platform.openai.com/docs/api-reference/chat) to other workloads on or off cluster, or to integrate your self-hosted models alongside model-as-a-service providers in a higher level **AI Gateway** like LiteLLM, Solo AI Gateway, or Apigee.
426

0 commit comments

Comments
 (0)