diff --git a/docs/cli.md b/docs/cli.md index 90fa4af..311647f 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -44,7 +44,7 @@ To upload an algorithm, use the following command: ./build/cocos-cli algo /path/to/algorithm /path/to/private/key ``` -Currently, support is provided for three types of algorithms: executable binaries, Python files, and Docker images (provided as tar files). The above command expects an algorithm in binary format that will be executed inside the secure VM by the agent. For Python files, the algo file, the requirements file, and the Python runtime are required. For Docker images, the Docker image is required along with the Docker start command and the absolut paths to directories where the datasets and results directories of the SVM will be mounted. +Currently, support is provided for three types of algorithms: executable binaries, Python files, and Docker images (provided as tar files). The above command expects an algorithm in binary format that will be executed inside the secure VM by the agent. For Python files, the algo file, the requirements file, and the Python runtime are required. For Docker images, the Docker image is required. To run a python file, use the following command: @@ -54,7 +54,7 @@ To run a python file, use the following command: to run a Docker image (instructions for building a docker image that uses the `lin_reg.py` algorithm from the cocos repository can be found [here](docker)), use the following command: ```bash -./build/cocos-cli algo /path/to/algorithm /path/to/private/key --algorithm docker --dockercmd "docker run command" --datasets "/cocos/datasets" --results "/cocos/results" +./build/cocos-cli algo /path/to/algorithm /path/to/private/key --algorithm docker" ``` The agent grpc url is required for this operation, this will be available once the TEE has been provisioned and agent is running. @@ -63,18 +63,11 @@ Supported flags: ```shell -a, --algorithm string Algorithm type to run (default "bin") - --datasets string The absolut path to the directory inside the docker image where the datasets will be mounted (default "/cocos/datasets") - -c, --dockercmd string The docker start command (default "python3 /cocos/algorithm.py") -h, --help help for algo --python-runtime string Python runtime to use (default "python3") -r, --requirements string Python requirements file - --results string The absolut path to the directory inside the docker image where the results directory will be mounted (default "/cocos/results") ``` -##### Example Docker image - -This is an ex - #### Upload Dataset To upload a dataset, use the following command: diff --git a/docs/docker.md b/docs/docker.md index 5e2a986..a7ae15a 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -37,5 +37,5 @@ docker save linreg > linreg.tar When the SVM starts, you can use the flag `algorithm` with the value `docker` of the `algo` CLI option to send the docker image to the Agent. ```bash -go run ./cocos/cmd/cli/main.go algo --algorithm docker ./linreg.tar +go run ./cocos/cmd/cli/main.go algo --algorithm docker ./linreg.tar ```