Documentation for save-mode additions

docs/_users-guide/workload-suite-config.md

@@ -20,12 +20,13 @@ Workload suites can be composed with each other for benchmarking tasks or to sim
 
 ## Parameters
 
-| Name    | Required | Description |  
-| ---------- | ----- | --- |    
-| benchmark-output | no | path to the file where benchmark results should be stored, or use `"console"` to print to the terminal |
-| descr | yes | Human-readable string description of what the suite intends to do |
-| parallel  | no | Whether the workloads in the suite run serially or in parallel. Defaults to `false`. |  
-| repeat  | no | How many times the workloads in the suite should be repeated. |  
+| Name             | Required | Default | Description |  
+| ---------------- | -------- | ------- | ----------- |    
+| benchmark-output | no       | -       | path to the file where benchmark results should be stored, or use `"console"` to print to the terminal |
+| save-mode        | no       | errorifexists | Options are "errorifexists", "ignore" (no-op if exists), "overwrite", and "append" |
+| descr            | yes      | -       | Human-readable string description of what the suite intends to do |
+| parallel         | no       | false   | Whether the workloads in the suite run serially or in parallel. Defaults to `false`. |  
+| repeat           | no       | 1       | How many times the workloads in the suite should be repeated. |  
 
 ## benchmark-output
 
@@ -68,6 +69,18 @@ workload-suites = [
 ]
 ```
 
+## save-mode
+
+If users specify benchmark-output they can use this option to specify write behavior.
+Options are
+  - errorifexists: if the file exists, throw an error
+  - ignore: if the file exists, no-op
+  - overwrite: if the file exists, overwrite it
+  - append: if the file exists, append to it
+
+Note: "append" is allowed for benchmark-output as it may be conceptually the same dataset,
+but disallowed for workload output as those are conceptually different datasets.
+
 ## descr
 
 `descr` is simply a human-readable string that gets added to benchmark results.

docs/_workloads/data-generator-graph.md

@@ -30,6 +30,7 @@ All other output file formats will cause an error.
 | ------- |---------------| ---------| ----------- |  
 | name       | yes | -- | "graph-data-generator" |  
 | output   | yes | -- | output file. MUST BE .TXT FORMAT |
+| save-mode | no | errorifexists | Options are "errorifexists", "ignore" (no-op if exists), and "overwrite" |
 | vertices      | yes | -- | Number of vertices in the graph |  
 | mu | no | 4.0 | mean of out-degree distribution |  
 | sigma | no| 1.3 | standard deviation of out-degree distribution |  

docs/_workloads/data-generator-kmeans.md

@@ -11,6 +11,7 @@ title: Data Generator - KMeans
 | rows      | yes | -- | number of rows to generate |
 | cols     | yes | -- | number of columns to generate |
 | output   | yes | -- | output file |
+| save-mode | no | errorifexists | Options are "errorifexists", "ignore" (no-op if exists), and "overwrite" |
 | k      | no | 2 | number of clusters generated |
 | scaling | no | 0.6 | scaling factor of the the dataset|
 | partitions | no| 2 | number of partitions|

docs/_workloads/data-generator-linear-regression.md

@@ -10,6 +10,7 @@ title: Data Generator - Linear Regression
 | rows      | yes | -- | number of rows to generate |
 | cols     | yes | -- | number of columns to generate |
 | output   | yes | -- | output file |
+| save-mode | no | errorifexists | Options are "errorifexists", "ignore" (no-op if exists), and "overwrite" |
 | eps      | no | 2 | epsilon factor by which examples are scaled |
 | intercepts | no | 0.1 | data intercept |
 | partitions | no| 10 | number of partitions|

docs/_workloads/kmeans.md

@@ -21,6 +21,7 @@ will be passed upwards and outputted with the workload suite.
 | name       | yes | -- | "kmeans" |
 | input | yes | -- | the input dataset |
 | output | no | -- | If users wish to capture the actual results of the kmeans algorithm, they can specify an output file here. |
+| save-mode | no | errorifexists | Options are "errorifexists", "ignore" (no-op if exists), and "overwrite" |
 | k     | no | 2 | number of clusters |
 | seed  | no | 127L | initial values |
 | maxiterations  | no | 2 | maximum number of times the algorithm should iterate |  

docs/_workloads/logistic-regression.md

@@ -15,6 +15,7 @@ Runs LogisticRegression over the input datasets.
 | input          | yes | --    | path to the training dataset |
 | testfile       | yes | --    | path to the test dataset |
 | output         | no  | --    | If users wish to capture the actual results of the workload, they can specify an output file here. |
+| save-mode | no | errorifexists | Options are "errorifexists", "ignore" (no-op if exists), and "overwrite" |
 | numpartitions  | no  | 32    | number of partitions |
 | cacheenabled   | no  | false | whether or not the datasets are cached after being read from disk |
 

docs/_workloads/sql.md

@@ -23,6 +23,7 @@ select `0` from input where `0` < -0.9
 | name        | yes      | -- | "sql" |
 | input       | yes      | -- | the input dataset |
 | output      | no       | -- | If users wish to capture the actual results of the SQL query, they can specify an output file here. |
+| save-mode | no | errorifexists | Options are "errorifexists", "ignore" (no-op if exists), and "overwrite" |
 | query    | yes      | --    | the sql query to perform. The table name must be "input" as shown in the examples above. |
 | cache       | no       | false | whether the dataset should be cached after being read from disk |