oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00
Code Releases Activity

fix lint

Browse Source
This commit is contained in:
alexcos20 2021-04-20 04:05:13 -07:00
parent 5194b96c5a
commit b5f75cc174
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
content/tutorials/write-c2d-algorithms.md
View File

@ -6,13 +6,14 @@ description: Writing C2D Algorithms
## Overwiew ## Overwiew
An C2D algorithm is composed of the following: An C2D algorithm is composed of the following:
- a docker image (base image) - a docker image (base image)
- an algorithm code - an algorithm code
- a entry point - a entry point
That's why, while creating the algorithm asset in ocean, we need the additional object "algorithm" defined in the metadata service: That's why, while creating the algorithm asset in ocean, we need the additional object "algorithm" defined in the metadata service:
``` ```json
"algorithm": { "algorithm": {
"container": { "container": {
"entrypoint": "node $ALGO", "entrypoint": "node $ALGO",
@ -21,14 +22,18 @@ That's why, while creating the algorithm asset in ocean, we need the additional
} }
} }
``` ```
Most important attributes are the following: Most important attributes are the following:
- image: this is the docker image that your are going to use - image: this is the docker image that your are going to use
- tag: this is the docker image tag that you are going to use - tag: this is the docker image tag that you are going to use
- entrypoint: this is the entrypoint. $ALGO is a macro that gets replaced inside C2D, depending where your algo code is downloaded - entrypoint: this is the entrypoint. $ALGO is a macro that gets replaced inside C2D, depending where your algo code is downloaded
Here are some examples: Here are some examples:
- to run a JS algo, based on node 14: - to run a JS algo, based on node 14:
```
```json
"algorithm": { "algorithm": {
"container": { "container": {
"entrypoint": "node $ALGO", "entrypoint": "node $ALGO",
@ -37,8 +42,10 @@ Here are some examples:
} }
} }
``` ```
- to run a python algo, based on python:3.9.4-alpine3.13: - to run a python algo, based on python:3.9.4-alpine3.13:
```
```json
"algorithm": { "algorithm": {
"container": { "container": {
"entrypoint": "python3.9 $ALGO", "entrypoint": "python3.9 $ALGO",
@ -67,11 +74,12 @@ All algorithm output (such as print, console.log, etc) are going to be stored in
For every algorithm pod, C2D is going to provide the following ENVs: For every algorithm pod, C2D is going to provide the following ENVs:
- DIDS: this is an array containing the input datasets - DIDS: this is an array containing the input datasets
- TRANSFORMATION_DID: this is the algorithm did - TRANSFORMATION_DID: this is the algorithm did
# Sample Algorithms ## Sample Algorithms
## JS example ## JS example
@ -114,7 +122,8 @@ processfolder(input_folder)
``` ```
To run this, use the following container object: To run this, use the following container object:
```
```json
"algorithm": { "algorithm": {
"container": { "container": {
"entrypoint": "node $ALGO", "entrypoint": "node $ALGO",
@ -194,7 +203,8 @@ if __name__ == '__main__':
``` ```
To run this, use the following container object: To run this, use the following container object:
```
```json
"algorithm": { "algorithm": {
"container": { "container": {
"entrypoint": "python3.6 $ALGO", "entrypoint": "python3.6 $ALGO",