Skip to content

Commit 23714b4

Browse files
authored
Update documentation to add Olive CI workflow instructions (microsoft#191)
1 parent ff618fd commit 23714b4

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,19 @@ aitk:
6161
file: "bert_trtrtx.json"
6262
```
6363

64+
## Setup CI for Olive recipes
65+
CI for Olive recipes can be configured to run automatically by adding `olive_ci.json` file under the model directory. Each entry in the file is configured to run as an independent GitHub Actions job.
66+
67+
Each `olive_ci.json` is unique to the folder it contains and, at the minimum, should contain the following information for each root entry:
68+
69+
* name [str]: a unique identifier to locate specific job
70+
* os [str]: options are ubuntu or windows
71+
* device [str]: options are cpu or cuda.
72+
* requirements_file [str]: relative file path to requirements file to use for this job. The job will use this file to setup the environment to run the commands.
73+
* command [str]: a list of commands concatenated by either '&&' (on unix-like platforms) or separated by ';' (on windows platforms). This entry can also point to a shell or python script which can implement more complicated/advanced logic to run. When referring to a shell or python script, the path is relative to the location of the corresponding `olive_ci.json` file.
74+
75+
For an example, refer to the following [olive_ci.json](intel-bert-base-uncased-mrpc/oci/olive_ci.json) implementation.
76+
6477
## Coding conventions and standards
6578

6679
### Testing and Code Coverage

0 commit comments

Comments
 (0)