A team algorithm is Python code your team writes. You write the code, try it on one to three recordings, and save it as a version. The saved version appears in the algorithm library, and the console builds its container image.
Who can do this: Owner, Admin, Researcher.
Using a team algorithm in a workflow: coming soon
Adding a saved team algorithm to a workflow and running it there is not available yet. This page covers writing the code, trying it on a sample, and saving a version.
Open a new algorithm
Open Algorithms, choose the Custom tab, then choose New algorithm. The empty tab has the same button.
Choose Write in the browser
Choose Write in the browser. You can also start from an example: Pre-check on raw files, Check on the final recording or Post-processing feature. Each example is a complete starting point.
Fill in the details and write the code
The editor has these areas. Enter the Algorithm name and the Title first. The editor asks for them before you can run or save.
| Field | What to enter | Example |
|---|---|---|
| ① Algorithm name | Lower-case letters, digits and hyphens. | camera-gap-check |
| ① Title | The name people see in the library. | Camera gap check |
| ② Code | Define run(ctx). It runs once for each recording. | def run(ctx): ... |
| ③ Requirements | Python packages to install, such as numpy>=1.26. | numpy>=1.26 |
| ④ Version | The version to save. The editor suggests one after you add a name and a title. | The suggested version |
| ⑤ Sample run | Recordings to try the code on. See the next step. | One to three recordings |
Inputs and outputs and Parameters are further down the editor. Set them up before you save the version.
Try the code on a sample
In Sample run, choose Metadata only or Real recording files. Then choose a project and one to three recordings, and choose Run on sample. A sample run does not save anything.
Save the version
Choose Save version at the top right. The version is saved and appears in the library. The console then builds the algorithm image under Image build. A first build can take about 10 minutes.
Troubleshooting
Save version is not available
Add a name and a title first. The editor asks for both before it saves.
The page says cloud build or registry push is off
The page says cloud build is off for this deployment, or that it does not accept registry pushes and asks you to register an external image instead. Ask your administrator which option is available.