Skip to content

Commit c52711e

Browse files
author
Paweł Kędzia
committed
Merge branch 'features/readme'
2 parents 988ce27 + 370ee36 commit c52711e

File tree

4 files changed

+10
-54
lines changed

4 files changed

+10
-54
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
## llm‑router
22

3-
A lightweight, extensible gateway that exposes a clean **REST** API for interacting with
4-
multiple Large Language Model (LLM) providers (OpenAI, Ollama, vLLM, etc.).
5-
It centralises request validation, prompt management, model configuration and logging,
3+
A lightweight, extensible gateway that exposes a clean **REST** API for interacting with
4+
multiple Large Language Model (LLM) providers (OpenAI, Ollama, vLLM, etc.).
5+
It centralises request validation, prompt management, model configuration and logging,
66
allowing your application to talk to any supported LLM through a single, consistent interface.
77

8-
This project provides a robust solution for managing and routing requests to various LLM backends.
9-
It simplifies the integration of LLMs into your applications by offering a unified API
8+
This project provides a robust solution for managing and routing requests to various LLM backends.
9+
It simplifies the integration of LLMs into your applications by offering a unified API
1010
and advanced features like load balancing strategies.
1111

1212
---

llm_router_api/README.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,6 @@ and offers a unified REST interface with built‑in load‑balancing, health‑c
88
99
---
1010

11-
## Table of Contents
12-
13-
1. [Features](#features)
14-
2. [Installation](#installation)
15-
3. [Configuration](#configuration)
16-
4. [Running the Server](#running-the-server)
17-
5. [REST API Overview](#rest-api-overview)
18-
6. [Load‑Balancing Strategies](#load‑balancing-strategies)
19-
7. [Extending the Router](#extending-the-router)
20-
8. [Monitoring & Metrics](#monitoring--metrics)
21-
9. [Development & Testing](#development--testing)
22-
10. [License](#license)
23-
24-
---
25-
2611
## Features
2712

2813
- **Unified API** – One REST surface (`/api/...`) that proxies calls to any supported LLM back‑end.

llm_router_lib/README.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,15 @@
1-
# llm‑router — Python client library
1+
# llm‑router-LIB — Python client library
22

3-
**llm‑router** is a lightweight Python client for interacting with the LLM‑Router API.
3+
**llm‑router** is a lightweight Python client for interacting with the LLM‑Router API.
44
It provides typed request models, convenient service wrappers, and robust error handling so you can focus on building
55
LLM‑driven applications rather than dealing with raw HTTP calls.
66

77
---
88

9-
## Table of Contents
10-
11-
1. [Overview](#overview)
12-
2. [Features](#features)
13-
3. [Installation](#installation)
14-
4. [Quick start](#quick-start)
15-
5. [Core concepts](#core-concepts)
16-
- [Client](#client)
17-
- [Data models](#data-models)
18-
- [Services](#services)
19-
- [Utilities](#utilities)
20-
- [Error handling](#error-handling)
21-
6. [Testing](#testing)
22-
7. [Contributing](#contributing)
23-
8. [License](#license)
24-
25-
---
26-
279
## Overview
2810

29-
`llm_router_lib` is the official Python SDK for the **LLM‑Router** project <https://github.com/radlab-dev-group/llm-router>.
11+
`llm_router_lib` is the official Python SDK for the **LLM‑Router**
12+
project <https://github.com/radlab-dev-group/llm-router>.
3013

3114
It abstracts the HTTP layer behind a small, well‑typed API:
3215

@@ -70,7 +53,7 @@ If you prefer a regular installation from a wheel or source distribution, use:
7053
pip install .
7154
```
7255

73-
> **Note** – The project relies only on the packages listed in the repository’s `requirements.txt`
56+
> **Note** – The project relies only on the packages listed in the repository’s `requirements.txt`
7457
> (pydantic, requests, etc.), all of which are installed automatically by `pip`.
7558
7659
---

llm_router_web/README.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,6 @@
44
** project.
55
It provides a Flask‑based UI for managing LLM model configurations, users, and version history.
66

7-
## Table of Contents
8-
9-
- [Features](#features)
10-
- [Installation](#installation)
11-
- [Running the Application](#running-the-application)
12-
- [Configuration](#configuration)
13-
- [Endpoints Overview](#endpoints-overview)
14-
- [Development](#development)
15-
- [License](#license)
16-
17-
---
18-
197
## Features
208

219
- **User Management** – Admins can create, edit, block/unblock users and assign roles (`admin` / `user`).

0 commit comments

Comments
 (0)