Skip to content

Commit 29f34ca

Browse files
authored
Update README.md
1 parent 11a18ab commit 29f34ca

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,18 @@ This action would be a good fit for your workflow if you are using a Jupyter not
88

99
## How does it work?
1010

11-
The Github Action will get deploy your model file to a data collection at Algorithmia and create a new build for your inference endpoint to use the new model, whenever you do a Git push to your master branch (or any other triggering event you configure).
11+
Whenever you do a Git push to your master branch (or any other triggering event you configure), your workflow integrating this Github Action will kick off.
1212

1313
![](images/overview.png)
1414

15-
Depending on your model development preference:
16-
17-
If you're developing your ML model on a Jupyter notebook, you can configure the workflow with the notebook path to execute. In this case, the workflow will run the notebook on the CI worker machine's from-scratch environment.
18-
If you have an already saved model checked-in to your repository, you can configure the workflow with the existing model file path.
19-
20-
In both scenarios, the workflow will get the model file and upload it to the configured data collection on Algorithmia.
15+
- If you're developing your ML model in a Jupyter notebook, you can configure the workflow with the notebook path to execute. In this case, the Github Action will:
16+
- Install the required packages in your requirements.txt file on a Github worker machine
17+
- Run your configured Jupyter notebook file on the worker machine's from-scratch environment
18+
If not and if you have an already saved model checked-in to your repository, you can configure the workflow with the existing model file path.
19+
In both scenarios, the Github Action will then:
20+
- Take the ML model file from the configured path and upload it to your data collection at Algorithmia
21+
- Copy your inference (algorithm) script to your algorithm repository
22+
- Update/create a model_manifest.json file, connecting your inference (algorithm) code at Algorithmia with this newly uploaded model file
2123

2224
![](images/flowchart.png)
2325

0 commit comments

Comments
 (0)