Register docker image

The 'Docker Images' page is available at 'Data->Process->Docker Images' on the left navigation panel as shown below. 

The Data Explorer default provided docker images are listed with the 'Akridata' badge, as shown above. To use a custom docker image in Pipelines, the docker image must be registered as per the instructions on this page.

To register a docker image, follow the below steps.

1. Click on the '+Register Docker Image' button at the top right of the above page. This opens a form as below
   
2. Fill in the form fields as per the instructions below.
   1. Repository: Select a docker repository available as a drop-down list. The drop-down list contains all the eligible docker repositories that are registered on the Docker Repositories page.
   2. Docker Image Name: The name of the docker image as uploaded to the docker repository using the docker push command. Please refer to Publish-docker-image for more details.
   3. Docker Image Tag: The default value of 'latest' will pick the latest available docker image whenever the 'adectl run' is executed. To register a specific fixed version of the docker image, enter the specific tag here.
   4. Name: A identifiable name which will be displayed on the Data Explorer UI.
   5. Filter type: Select from the drop-down of docker types like 'Featurizer', 'Image Preprocessor', 'Thumbnail generator' and 'Attribute generator'. Depending on the type selected, additional form fields will open up, and these fields are described later in this article.
   6. Add Docker command: Enter the docker command to be executed inside the docker. For the example program described in Develop-docker-image, this field should be filled with 'python3 /opt/akridata/thumbnail.py'.
   7. GPU Usage: Select from available options 'No GPU required', 'GPU mandatorily required', and 'Use GPU if available' depending on the expectations and constraints of the program within the docker image.
3. Click on the 'Save' button.

Fields based on docker(filter) type

Thumbnail generator

A thumbnail generator does not take any docker type-specific fields.

Image Preprocessor

An image preprocessor does not take any docker type-specific fields.

Featurizer

The 'Feature Dimensions' section to be filled specifically for a featurizer is described below.

1. Select between 1D and 3D depending on whether features are generated on the full image or on individual cells of a grid over the image respectively. 
2. If 3D is selected, enter the Grid Size in the fields provided.
3. Enter the 'No of Features' produced for each image(1D) or a cell of the image(3D).
4. Patch search is allowed only with a 3D featurizer. 

Attribute generator

For an attribute generator type of docker, specify the name of the columns generated by the docker and their corresponding data type. If the specification here has N columns, then the output CSV file(refer to Interface specification) is expected to have N+1 columns with first column being the file_path.