diff --git a/developers/compute-to-data/compute-to-data-algorithms.md b/developers/compute-to-data/compute-to-data-algorithms.md index c08b5c86..116110a7 100644 --- a/developers/compute-to-data/compute-to-data-algorithms.md +++ b/developers/compute-to-data/compute-to-data-algorithms.md @@ -34,7 +34,7 @@ When creating an algorithm asset in Ocean Protocol, it is essential to include t -
VariableUsage
imageThe Docker image name the algorithm will run with.
tagThe Docker image tag that you are going to use.
entrypointThe Docker entrypoint. $ALGO is a macro that gets replaced inside the compute job, depending where your algorithm code is downloaded.
+
VariableUsage
imageThe Docker image name the algorithm will run with.
tagThe Docker image tag that you are going to use.
entrypointThe Docker entrypoint. $ALGO is a macro that gets replaced inside the compute job, depending where your algorithm code is downloaded.
Define your entry point according to your dependencies. E.g. if you have multiple versions of Python installed, use the appropriate command `python3.6 $ALGO`. @@ -97,7 +97,7 @@ Please note that when using local Providers or Metatata Caches, the ddos might n For every algorithm pod, the Compute to Data environment provides the following environment variables: -
VariableUsage
DIDSAn array of DID strings containing the input datasets.
TRANSFORMATION_DIDThe DID of the algorithm.
+
VariableUsage
DIDSAn array of DID strings containing the input datasets.
TRANSFORMATION_DIDThe DID of the algorithm.
@@ -248,13 +248,13 @@ To run this algorithm, use the following `container` object: An asset of type `algorithm` has additional attributes under `metadata.algorithm`, describing the algorithm and the Docker environment it is supposed to be run under. -
AttributeTypeDescription
languagestringLanguage used to implement the software.
versionstringVersion of the software preferably in SemVer notation. E.g. 1.0.0.
consumerParametersConsumer ParametersAn object that defines required consumer input before running the algorithm
container*containerObject describing the Docker container image. See below
+
AttributeTypeDescription
languagestringLanguage used to implement the software.
versionstringVersion of the software preferably in SemVer notation. E.g. 1.0.0.
consumerParametersConsumer ParametersAn object that defines required consumer input before running the algorithm
container*containerObject describing the Docker container image. See below
\* Required The `container` object has the following attributes defining the Docker image for running the algorithm: -
AttributeTypeDescription
entrypoint*stringThe command to execute, or script to run inside the Docker image.
image*stringName of the Docker image.
tag*stringTag of the Docker image.
checksum*stringDigest of the Docker image. (ie: sha256:xxxxx)
+
AttributeTypeDescription
entrypoint*stringThe command to execute, or script to run inside the Docker image.
image*stringName of the Docker image.
tag*stringTag of the Docker image.
checksum*stringDigest of the Docker image. (ie: sha256:xxxxx)
\* Required