From 364b0fcf7d5d4b73831e1cfdc8618871c237b56a Mon Sep 17 00:00:00 2001 From: Akshay Date: Mon, 9 May 2022 18:16:24 +0200 Subject: [PATCH 1/6] Issue-#982: Fix grammer issue --- content/concepts/did-ddo.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/concepts/did-ddo.md b/content/concepts/did-ddo.md index ef1d97b9..436b4a6a 100644 --- a/content/concepts/did-ddo.md +++ b/content/concepts/did-ddo.md @@ -132,7 +132,7 @@ An asset of type `algorithm` has additional attributes under `metadata.algorithm | ------------------------ | ------------------------------------------- | -------- | ------------------------------------------------------------------------------------------ | | **`language`** | `string` | | Language used to implement the software. | | **`version`** | `string` | | Version of the software preferably in [SemVer](https://semver.org) notation. E.g. `1.0.0`. | -| **`consumerParameters`** | [Consumer Parameters](#consumer-parameters) | | An object the defines required consumer input before running the algorithm | +| **`consumerParameters`** | [Consumer Parameters](#consumer-parameters) | | An object that defines required consumer input before running the algorithm | | **`container`** | `container` | **✓** | Object describing the Docker container image. See below | The `container` object has the following attributes defining the Docker image for running the algorithm: From dada52d8cb217121457b1c2054a75bfd981bae35 Mon Sep 17 00:00:00 2001 From: Akshay Date: Sun, 15 May 2022 22:37:15 +0200 Subject: [PATCH 2/6] ISsue-#984: FIx ambiguous text in consumer parameters --- content/concepts/did-ddo.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/content/concepts/did-ddo.md b/content/concepts/did-ddo.md index 436b4a6a..5cefc3ec 100644 --- a/content/concepts/did-ddo.md +++ b/content/concepts/did-ddo.md @@ -444,11 +444,12 @@ Example: #### Consumer Parameters -Sometimes, you may need some input before downloading a dataset or running an algorithm. +Sometimes, the asset may need some input before downloading a dataset or running an algorithm. Examples: -- You want to know the desired sampling interval of data in your dataset, before the user is going to download it. Your dataset URL is `https://example.com/mydata`. So you will define a field called `sampling`, ask the user to enter a value and then this parameter is going to be added to the URL of your dataset as query parameters: `https://example.com/mydata?sampling=10` -- Before running an algorithm, you need to know how many iterations should it perform. You define a field called `iterations`, ask the user to enter a value and this parameter is stored in a specific location in your Computer-to-Data pod for the algorithm to read and use that value. +- The dataset publisher wants to know the desired sampling interval of data before the buyer downloads it. Suppose the dataset URL is `https://example.com/mydata`. So the publisher will define a field called `sampling`, ask the buyer to enter a value, and then this parameter is going to be added to the URL of the published dataset as query parameters: `https://example.com/mydata?sampling=10`. + +- Before running an algorithm, the algorithm needs to know how many iterations should it perform. In this case, the algorithm publisher defines a field called `iterations`. The buyer enters the value for the `iterations` parameter, and later this value is stored in a specific location in the Computer-to-Data pod for the algorithm to read and use that value. It's an array of elements, each element object defines a field. An element looks like: From eba78349fb9b23074f809832771211f352542648 Mon Sep 17 00:00:00 2001 From: Akshay Date: Mon, 16 May 2022 17:28:06 +0200 Subject: [PATCH 3/6] Issue-#982: Update consumer parameters section. --- content/concepts/did-ddo.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/concepts/did-ddo.md b/content/concepts/did-ddo.md index 5cefc3ec..b969319f 100644 --- a/content/concepts/did-ddo.md +++ b/content/concepts/did-ddo.md @@ -447,9 +447,9 @@ Example: Sometimes, the asset may need some input before downloading a dataset or running an algorithm. Examples: -- The dataset publisher wants to know the desired sampling interval of data before the buyer downloads it. Suppose the dataset URL is `https://example.com/mydata`. So the publisher will define a field called `sampling`, ask the buyer to enter a value, and then this parameter is going to be added to the URL of the published dataset as query parameters: `https://example.com/mydata?sampling=10`. +- Sometimes, the asset needs additional input data before downloading a dataset or running an algorithm. The publisher needs to know the sampling interval before the buyer downloads it. Suppose the dataset URL is `https://example.com/mydata`. The publisher then defines a field called sampling and asks the buyer to enter a value. This parameter is added to the URL of the published dataset as query parameters: `https://example.com/mydata?sampling=10`. -- Before running an algorithm, the algorithm needs to know how many iterations should it perform. In this case, the algorithm publisher defines a field called `iterations`. The buyer enters the value for the `iterations` parameter, and later this value is stored in a specific location in the Computer-to-Data pod for the algorithm to read and use that value. +- An algorithm that needs to know how many iterations it should perform. In this case, the algorithm publisher defines a field called `iterations`. The buyer needs to enter a value for the `iterations` parameter. Later, this value is stored in a specific location in the Computer-to-Data pod for the algorithm to read and use it. It's an array of elements, each element object defines a field. An element looks like: From 83e60469de7d85d67df65a5493128498ac6f5896 Mon Sep 17 00:00:00 2001 From: Akshay Date: Tue, 17 May 2022 10:51:38 +0200 Subject: [PATCH 4/6] Issue-#984: FIx ambiguous text in consumer parameters --- content/concepts/did-ddo.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/concepts/did-ddo.md b/content/concepts/did-ddo.md index b969319f..8dfd73f5 100644 --- a/content/concepts/did-ddo.md +++ b/content/concepts/did-ddo.md @@ -447,7 +447,7 @@ Example: Sometimes, the asset may need some input before downloading a dataset or running an algorithm. Examples: -- Sometimes, the asset needs additional input data before downloading a dataset or running an algorithm. The publisher needs to know the sampling interval before the buyer downloads it. Suppose the dataset URL is `https://example.com/mydata`. The publisher then defines a field called sampling and asks the buyer to enter a value. This parameter is added to the URL of the published dataset as query parameters: `https://example.com/mydata?sampling=10`. +- The publisher needs to know the sampling interval before the buyer downloads it. Suppose the dataset URL is `https://example.com/mydata`. The publisher then defines a field called `sampling` and asks the buyer to enter a value. This parameter is added to the URL of the published dataset as query parameters: `https://example.com/mydata?sampling=10`. - An algorithm that needs to know how many iterations it should perform. In this case, the algorithm publisher defines a field called `iterations`. The buyer needs to enter a value for the `iterations` parameter. Later, this value is stored in a specific location in the Computer-to-Data pod for the algorithm to read and use it. From 68bdee4edeb296af00311cedfae02dcea660a039 Mon Sep 17 00:00:00 2001 From: Akshay Date: Tue, 17 May 2022 11:13:45 +0200 Subject: [PATCH 5/6] Fix quotes in did-ddo.md --- content/concepts/did-ddo.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/concepts/did-ddo.md b/content/concepts/did-ddo.md index 8dfd73f5..dcade279 100644 --- a/content/concepts/did-ddo.md +++ b/content/concepts/did-ddo.md @@ -212,7 +212,7 @@ Type of objects supported : Description Example -'url' +url Static URL. Contains url and HTTP method @@ -238,7 +238,7 @@ First class integrations supported in the future : Example -"ipfs"IPFS files +ipfsIPFS files ```json @@ -252,10 +252,10 @@ First class integrations supported in the future : -"filecoin"Filecoin storage  -"arwave"Arwave  -"storj"Storj  -"sql"Sql connection, dataset is generated by a query  +filecoinFilecoin storage  +arwaveArwave  +storjStorj  +sqlSql connection, dataset is generated by a query  A service can contain multiple files, using multiple storage types. From e6c6e55185e5730926619435d054529c0dbbb1aa Mon Sep 17 00:00:00 2001 From: Ana Loznianu Date: Tue, 17 May 2022 13:09:19 +0300 Subject: [PATCH 6/6] Minor updates to the consumer parameters examples --- content/concepts/did-ddo.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/concepts/did-ddo.md b/content/concepts/did-ddo.md index dcade279..7a467dc4 100644 --- a/content/concepts/did-ddo.md +++ b/content/concepts/did-ddo.md @@ -444,12 +444,12 @@ Example: #### Consumer Parameters -Sometimes, the asset may need some input before downloading a dataset or running an algorithm. +Sometimes, the asset needs additional input data before downloading a dataset or running an algorithm. Examples: -- The publisher needs to know the sampling interval before the buyer downloads it. Suppose the dataset URL is `https://example.com/mydata`. The publisher then defines a field called `sampling` and asks the buyer to enter a value. This parameter is added to the URL of the published dataset as query parameters: `https://example.com/mydata?sampling=10`. +- The publisher needs to know the sampling interval before the buyer downloads it. Suppose the dataset URL is `https://example.com/mydata`. The publisher defines a field called `sampling` and asks the buyer to enter a value. This parameter is then added to the URL of the published dataset as query parameters: `https://example.com/mydata?sampling=10`. -- An algorithm that needs to know how many iterations it should perform. In this case, the algorithm publisher defines a field called `iterations`. The buyer needs to enter a value for the `iterations` parameter. Later, this value is stored in a specific location in the Computer-to-Data pod for the algorithm to read and use it. +- An algorithm that needs to know the number of iterations it should perform. In this case, the algorithm publisher defines a field called `iterations`. The buyer needs to enter a value for the `iterations` parameter. Later, this value is stored in a specific location in the Computer-to-Data pod for the algorithm to read and use it. It's an array of elements, each element object defines a field. An element looks like: