You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-1Lines changed: 32 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,6 +140,38 @@ Where each notebook given to millrun will execute against each dictionary in the
140
140
This format is offered as a convenience format. Internally, it is converted into "Format 1" prior to execution.
141
141
142
142
143
+
## CLI Profile execution
144
+
145
+
As of v0.2.0, `millrun` allows the creation of a "profiles" yaml file which prevents the need for typing really long commands on the command line, especially if, for a particular project, the commands are always going to be the same.
146
+
147
+
YAML format:
148
+
149
+
The format basically describes the kwargs required to execute the command.
150
+
151
+
The top level keys can be arbitrarily named but they represent one command execution.
152
+
The values underneath each top level key are the kwargs of the command.
153
+
154
+
The only required values are `notebook_dir_or_file` and `notebook_params`. All other params are optional.
155
+
156
+
```yaml
157
+
notebook1: # This is the name of the profile. A profile is equal to one command on the command line
Since millrun iterates over two dimensions (each notebook and then dict of parameters in the list), there are two ways of parellelizing:
@@ -153,7 +185,6 @@ However, this method becomes inefficient if you have MANY notebooks and only 1-3
153
185
154
186
If you need this use case then feel free to raise an issue and/or contribute a PR to implement it as an option for execution.
155
187
156
-
157
188
## Troubleshooting
158
189
159
190
There seems to be an un-planned-for behaviour (by me) with the parallel execution where if there is an error in the execution process, that iteration is simply skipped. I don't have any `try`/`except` in the code that causes this.
0 commit comments