Skip to content

Commit 4d3dc99

Browse files
committed
[Docs] Update documentations and add logo
1 parent 55d0329 commit 4d3dc99

3 files changed

Lines changed: 21 additions & 61 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@ import { defineConfig } from 'vitepress'
33
export default defineConfig({
44
title: 'PyLet',
55
description: 'A Pythonic distributed task execution system for GPU servers',
6+
base: '/pylet-docs/',
67

78
head: [
8-
['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }],
9+
['link', { rel: 'icon', type: 'image/png', href: '/pylet_logo.png' }],
910
],
1011

1112
themeConfig: {
12-
logo: '/logo.svg',
13+
logo: '/pylet_logo.png',
1314

1415
nav: [
1516
{ text: 'Guide', link: '/getting-started/quickstart' },

docs/index.md

Lines changed: 18 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,29 @@
1-
---
2-
layout: home
1+
<div style="text-align: center; margin: 1.5rem 0 2rem;">
2+
<img src="/pylet-docs/pylet_logo.png" alt="PyLet" style="width: 100%; max-width: 480px;" />
3+
</div>
34

4-
hero:
5-
name: PyLet
6-
text: Pythonic GPU Cluster Management
7-
tagline: Pure Python, no containers, no YAML — just pylet start and pylet submit.
8-
actions:
9-
- theme: brand
10-
text: Quick Start
11-
link: /getting-started/quickstart
12-
- theme: alt
13-
text: View on GitHub
14-
link: https://github.com/ServerlessLLM/pylet
5+
# PyLet
156

16-
features:
17-
- icon: 🚀
18-
title: Simple
19-
details: One pip install, ~5 commands to learn. No containers, no complex configs.
20-
- icon: 🎮
21-
title: GPU-Aware
22-
details: Automatic GPU allocation via CUDA_VISIBLE_DEVICES. Request by count or specific indices.
23-
- icon: 🔍
24-
title: Service Discovery
25-
details: Instances get a PORT env var. Look up endpoints with one command.
26-
- icon: 🐍
27-
title: Python API
28-
details: Full programmatic control alongside the CLI. Async API included.
29-
- icon: 📄
30-
title: Config Files
31-
details: Define jobs in TOML for reproducibility. CLI args override config values.
32-
- icon: 📋
33-
title: Real-Time Logs
34-
details: Stream logs from running instances. Never lose output — even on crash.
35-
---
7+
PyLet is a lightweight distributed task execution system for GPU servers. Pure Python, no containers, no YAML — just `pylet start` and `pylet submit`.
368

37-
## Install
9+
**Simple · GPU-Aware · Python-Native**
3810

39-
```bash
40-
pip install pylet
41-
```
11+
## Getting Started
4212

43-
## 30-Second Demo
13+
- [**Quick Start**](getting-started/quickstart) — Install PyLet and run your first task in 30 seconds
4414

45-
```bash
46-
# Terminal 1: Start the head node
47-
pylet start
15+
## Guide
4816

49-
# Terminal 2: Start a worker with 4 GPUs
50-
pylet start --head localhost:8000 --gpu-units 4
17+
- [**Core Concepts**](guide/concepts) — Tasks, workers, GPU allocation
18+
- [**Configuration**](guide/configuration) — TOML config files and CLI overrides
19+
- [**Examples**](guide/examples) — Common usage patterns and workflows
5120

52-
# Terminal 3: Run something!
53-
pylet submit 'echo Hello from PyLet!' --name hello
54-
```
21+
## Reference
5522

56-
That's it. You now have a working cluster.
23+
- [**CLI Reference**](reference/cli) — All commands and options
24+
- [**Python API**](reference/python-api) — Programmatic and async API
5725

58-
## Why PyLet?
26+
## Advanced
5927

60-
| Problem | PyLet's Answer |
61-
|:--------|:---------------|
62-
| "Who's using which GPU?" | Automatic GPU allocation via `CUDA_VISIBLE_DEVICES` |
63-
| "How do I run my job on a remote machine?" | `pylet submit "python train.py" --gpu-units 2` |
64-
| "How do I find my running service?" | `pylet get-endpoint --name my-service` |
65-
| "I just want to run something, not learn K8s" | PyLet has ~5 commands to learn |
66-
67-
## Requirements
68-
69-
- Python 3.9+
70-
- Linux (tested on Ubuntu)
28+
- [**Architecture**](advanced/architecture) — System design and internals
29+
- [**Troubleshooting**](advanced/troubleshooting) — Common issues and solutions

docs/public/pylet_logo.png

3.06 MB
Loading

0 commit comments

Comments
 (0)