Add Runbooks proposal

substratusai · Oct 16, 2023 · 13de93f · 13de93f
1 parent 9958742
commit 13de93f
Show file tree

Hide file tree

Showing 3 changed files with 83 additions and 0 deletions.
diff --git a/docs/diagrams/runbook-storage.excalidraw.png b/docs/diagrams/runbook-storage.excalidraw.png
diff --git a/docs/diagrams/runbook-triggers.excalidraw.png b/docs/diagrams/runbook-triggers.excalidraw.png
diff --git a/docs/proposals/runbooks.md b/docs/proposals/runbooks.md
@@ -0,0 +1,83 @@
+# Runbooks
+
+Runbooks are templates for Runs.
+
+A Runbook of the following:
+
+```yaml
+apiVersion: substratus.ai/v1
+kind: Runbook
+metadata:
+  name: my-model
+spec:
+  index: 1 # Bump to create a new Run.
+  params:
+    epochs: 123
+```
+
+Will trigger a Run of the following:
+
+```yaml
+apiVersion: substratus.ai/v1
+kind: Run
+metadata:
+  name: my-model-1
+  labels:
+    index: "1"
+spec:
+  params: # Copied from Runbook.
+    epochs: 123
+```
+
+## Resources
+
+Runbooks can express resource requirements, Runs express exact resources.
+
+```yaml
+kind: Runbook
+metadata:
+  name: wiki-chat
+spec:
+  resources:
+    gpuMemoryGB:
+      min: 30
+    policy: Cheapest # alt: Fastest
+```
+
+```yaml
+kind: Run
+metadata:
+  name: wiki-chat-1
+spec:
+  resources:
+    nvidia-l4: 2
+```
+
+## Mounts
+
+```yaml
+kind: Runbook
+metadata:
+  name: wiki-chat
+spec:
+  runbooks:
+  - name: wiki-web-scrape
+    mount: data/
+    trigger: true # Create a Run for every new Run in the referenced Runbook.
+  - name: falcon-7b
+    mount: base-model/
+    index: 2 # Pin to a exact Run
+```
+
+```yaml
+kind: Run
+metadata:
+  name: wiki-chat-1
+spec:
+  runs:
+  - name: wiki-web-scrape-3
+    mount: data/
+  - name: falcon-7b-2
+    mount: base-model/
+```
+