This repository was archived by the owner on Aug 28, 2024. It is now read-only.
File tree Expand file tree Collapse file tree 3 files changed +85
-0
lines changed Expand file tree Collapse file tree 3 files changed +85
-0
lines changed Original file line number Diff line number Diff line change 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+ ## Runbook Relationships
57+
58+ Runbooks can mount the artifacts of other Runbooks.
59+
60+ ` ` ` yaml
61+ kind : Runbook
62+ metadata :
63+ name : wiki-chat
64+ spec :
65+ runbooks :
66+ - name : wiki-web-scrape
67+ mount : data/
68+ trigger : true # Create a Run for every new Run in the referenced Runbook.
69+ - name : falcon-7b
70+ mount : base-model/
71+ index : 2 # Pin to an exact Run.
72+ ` ` `
73+
74+ ` ` ` yaml
75+ kind : Run
76+ metadata :
77+ name : wiki-chat-1
78+ spec :
79+ runs :
80+ - name : wiki-web-scrape-3
81+ mount : data/
82+ - name : falcon-7b-2
83+ mount : base-model/
84+ ` ` `
85+
You can’t perform that action at this time.
0 commit comments