Prepare your code for containerization¶
Outlined above are the proposed paths that you can take to get your algorithm on our platform. As you can see, the first step toward deploying your algorithm is to prepare a code base that Docker can use to build a container. We provide several options for that – with options 1 and 2 you can use a pre-made example template and repository.
The options are:
-
Cloning a repository from a Challenge baseline Algorithm – choose this if you are participating in a challenge. This method might not require a local installation of Docker.
-
Creating an algorithm from an Algorithm Template – choose this method if you are solely creating an algorithm on our platform and want some quick examples. The examples contain a tailored template that already shows how to easily read and write your output, including some basic helper scripts for Docker containerisation. This method requires a local installation of Docker.
-
Handling the processing of your own inputs and outputs – choose this method if you want fine-grained control over how your data must be loaded and written. This can be the case when your algorithm or data are not compatible with any of the predefined templates. In practice, this means you also have to write code to load inputs and write outputs. This method very likely requires a local installation of Docker.
If you are unsure about whether to choose option 2 or option 3, please read the section about input and output interfaces.