Skip to content

Commit 30bc10d

Browse files
authored
Merge pull request #203 from docker/readme-updates
README.md updates for monorepo
2 parents 247003b + 028ad7a commit 30bc10d

1 file changed

Lines changed: 2 additions & 23 deletions

File tree

README.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,10 @@
11
# Model Runner
22

3-
The backend library for the
4-
[Docker Model Runner](https://docs.docker.com/desktop/features/model-runner/).
3+
Docker Model Runner (DMR) makes it easy to manage, run, and deploy AI models using Docker. Designed for developers, Docker Model Runner streamlines the process of pulling, running, and serving large language models (LLMs) and other AI models directly from Docker Hub or any OCI-compliant registry.
54

65
## Overview
76

8-
> [!NOTE]
9-
> This package is still under rapid development and its APIs should not be
10-
> considered stable.
11-
12-
This package supports the Docker Model Runner in Docker Desktop (in conjunction
13-
with [Model Distribution](./pkg/distribution) and the
14-
[Model CLI](./cmd/cli)). It includes a `main.go` that
15-
mimics its integration with Docker Desktop and allows the package to be run in a
16-
standalone mode.
17-
18-
## Contributing - Building from Source
19-
20-
This guide is for external contributors who want to build and test the complete Docker Model Runner ecosystem from source.
21-
22-
### Architecture Overview
23-
24-
The Docker Model Runner ecosystem consists of three main components:
25-
26-
- **[model-runner](https://github.com/docker/model-runner)** (this repository) - The backend daemon/server that manages and runs AI models
27-
- **[model-cli](https://github.com/docker/model-cli)** - The CLI client that communicates with model-runner
28-
- **[model-spec](https://github.com/docker/model-spec)** - The specification for packaging models as OCI artifacts
7+
This package supports the Docker Model Runner in Docker Desktop and Docker Engine.
298

309
### Prerequisites
3110

0 commit comments

Comments
 (0)