docker.wrapper: docker.wrapper()

In mellesies/vtg: Utilities for the vantage6 Federated Learning Infrastructure

docker.wrapper()

Description

This function is run by Docker when a vtg-based container is started. It handles communication (input/output) with the Node by reading/writing to files.

It expects the following environment variables to be set:

• DATABASE_URI: filename of a CSV file that can be read by the R-function read.csv() without specifying format-details.

• INPUT_FILE: filename that contains algorithm input in RDS format. Input should be a list() as created using create.task.input.unserialized().

• OUTPUT_FILE: filename of file that's used to write results to.

• TOKEN_FILE: filename of file contains a JSON Web Token.

Performs the following actions:

• Load data from the CSV file

• Loads the input parameters provided to the container in input.txt.

• Wraps the docker input/output for dispatch.RPC().

Usage

docker.wrapper(pkg = "")

Arguments

pkg	character() with the name of the R package to dispatch to.

Value

null; output will be written to output.txt

mellesies/vtg documentation built on Sept. 15, 2024, 2:32 a.m.