spiros / scikit-surgerydocker

This repo describes with a simple example how to use docker to containerise your project/algorithm

Home Page:https://scikit-surgerydocker.readthedocs.io/en/latest/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation Status

What is scikit-surgerydocker?

Scikit-srugerydocker is a template project that containerize (create docker image) Python project/algorithm. It specify the steps of how to share the project image with the world freely. It further explains how other users can download and execute image locally on their computer.

If your project/algorithm is like any ususal program i.e. gets input data, process it and produce results (as shown in the directory tree below) then you can use scikit-surgerydocker to containerise it for easy sharing and research reproducability.

.
├── input_data
│   ├── file-1
│   ├── file-2
│   └── file-n
├── output_data
│   ├── result-1
│   ├── result-2
│   └── result-n
└── src
    └── application.py

To give a better idea of how it works, the documentation describes containerization of two example projects. First example shows the CPU program (cpu-ex) and the second example shows the GPU program (stereo-recon-example). The documenation also explains how you can compress and upload your newly created docker images to a docker registry (dockerhub) for sharing with community.

Another related project scikit-surgerychallange we are working on could be used to download the docker image from the cloud repository and run it on different dataset. This can be particularly useful for hosting efficiency of containarized algorithm by providing specific hardware resource (RAM size, CPU, Number and type of GPU's) and specific execution time to each docker image. Together the scikit-surgerydocker and scikit-surgerychallange can be used to host research challanges.

Documentation

The documentation of the project can be found on readthedocs.

About

This repo describes with a simple example how to use docker to containerise your project/algorithm

https://scikit-surgerydocker.readthedocs.io/en/latest/

License:Other


Languages

Language:HTML 57.4%Language:JavaScript 32.3%Language:CSS 8.3%Language:Python 1.0%Language:Dockerfile 0.4%Language:Batchfile 0.3%Language:Makefile 0.3%