Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit 13de93f

Browse files
committed
Add Runbooks proposal
1 parent 9958742 commit 13de93f

File tree

3 files changed

+83
-0
lines changed

3 files changed

+83
-0
lines changed
160 KB
Loading
582 KB
Loading

docs/proposals/runbooks.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Runbooks
2+
3+
Runbooks are templates for Runs.
4+
5+
A Runbook of the following:
6+
7+
```yaml
8+
apiVersion: substratus.ai/v1
9+
kind: Runbook
10+
metadata:
11+
name: my-model
12+
spec:
13+
index: 1 # Bump to create a new Run.
14+
params:
15+
epochs: 123
16+
```
17+
18+
Will trigger a Run of the following:
19+
20+
```yaml
21+
apiVersion: substratus.ai/v1
22+
kind: Run
23+
metadata:
24+
name: my-model-1
25+
labels:
26+
index: "1"
27+
spec:
28+
params: # Copied from Runbook.
29+
epochs: 123
30+
```
31+
32+
## Resources
33+
34+
Runbooks can express resource requirements, Runs express exact resources.
35+
36+
```yaml
37+
kind: Runbook
38+
metadata:
39+
name: wiki-chat
40+
spec:
41+
resources:
42+
gpuMemoryGB:
43+
min: 30
44+
policy: Cheapest # alt: Fastest
45+
```
46+
47+
```yaml
48+
kind: Run
49+
metadata:
50+
name: wiki-chat-1
51+
spec:
52+
resources:
53+
nvidia-l4: 2
54+
```
55+
56+
## Mounts
57+
58+
```yaml
59+
kind: Runbook
60+
metadata:
61+
name: wiki-chat
62+
spec:
63+
runbooks:
64+
- name: wiki-web-scrape
65+
mount: data/
66+
trigger: true # Create a Run for every new Run in the referenced Runbook.
67+
- name: falcon-7b
68+
mount: base-model/
69+
index: 2 # Pin to a exact Run
70+
```
71+
72+
```yaml
73+
kind: Run
74+
metadata:
75+
name: wiki-chat-1
76+
spec:
77+
runs:
78+
- name: wiki-web-scrape-3
79+
mount: data/
80+
- name: falcon-7b-2
81+
mount: base-model/
82+
```
83+

0 commit comments

Comments
 (0)