You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by le...@apache.org on 2020/10/19 15:57:33 UTC
[incubator-datasketches-website] branch master updated: Adding
documentation for the ReqSketch
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-datasketches-website.git
The following commit(s) were added to refs/heads/master by this push:
new 6d7a053 Adding documentation for the ReqSketch
6d7a053 is described below
commit 6d7a0537990ecb7050f78b2272ca536a61ebfd52
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Mon Oct 19 08:56:18 2020 -0700
Adding documentation for the ReqSketch
---
docs/REQ/ReqAccuracyAdversarial.md | 40 +++++++++
docs/REQ/ReqAccuracyRandomShuffled.md | 96 ++++++++++++++++++++++
docs/img/req/ReqErrEqHraK12SL20T12_LT_Sh.png | Bin 0 -> 76293 bytes
docs/img/req/ReqErrEqHraK50SL20T0_LT_FlipFlop.png | Bin 0 -> 61136 bytes
docs/img/req/ReqErrEqHraK50SL20T0_LT_Random.png | Bin 0 -> 74839 bytes
docs/img/req/ReqErrEqHraK50SL20T0_LT_Reversed.png | Bin 0 -> 62110 bytes
docs/img/req/ReqErrEqHraK50SL20T0_LT_Sorted.png | Bin 0 -> 57982 bytes
docs/img/req/ReqErrEqHraK50SL20T0_LT_Sqrt.png | Bin 0 -> 71535 bytes
docs/img/req/ReqErrEqHraK50SL20T0_LT_Zoomin.png | Bin 0 -> 62363 bytes
docs/img/req/ReqErrEqHraK50SL20T0_LT_Zoomout.png | Bin 0 -> 61026 bytes
docs/img/req/ReqErrEqHraK50SL20T12_LT_NoSh.png | Bin 0 -> 61273 bytes
docs/img/req/ReqErrEqHraK50SL20T12_LT_Sh.png | Bin 0 -> 68221 bytes
docs/img/req/ReqErrEqLraK12SL20T12_LE_Sh.png | Bin 0 -> 73958 bytes
docs/img/req/ReqErrEqLraK50SL20T12_LE_Sh.png | Bin 0 -> 67648 bytes
14 files changed, 136 insertions(+)
diff --git a/docs/REQ/ReqAccuracyAdversarial.md b/docs/REQ/ReqAccuracyAdversarial.md
new file mode 100644
index 0000000..4dbc335
--- /dev/null
+++ b/docs/REQ/ReqAccuracyAdversarial.md
@@ -0,0 +1,40 @@
+---
+layout: doc_page
+---
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+# ReqSketch Accuracy with Adversarial Streams
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqHraK50SL20T12_LT_Sh.png" alt="/req/ReqErrEqHraK50SL20T12_LT_Sh.png" />
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqHraK50SL20T12_LT_NoSh.png" alt="/req/ReqErrEqHraK50SL20T12_LT_Sh.png" />
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqHraK50SL20T0_LT_Sorted.png" alt="/req/ReqErrEqHraK50SL20T12_LT_Sh.png" />
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqHraK50SL20T0_LT_Reversed.png" alt="/req/ReqErrEqHraK50SL20T12_LT_Sh.png" />
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqHraK50SL20T0_LT_Random.png" alt="/req/ReqErrEqHraK50SL20T12_LT_Sh.png" />
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqHraK50SL20T0_LT_Zoomin.png" alt="/req/ReqErrEqHraK50SL20T12_LT_Sh.png" />
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqHraK50SL20T0_LT_Zoomout.png" alt="/req/ReqErrEqHraK50SL20T12_LT_Sh.png" />
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqHraK50SL20T0_LT_Sqrt.png" alt="/req/ReqErrEqHraK50SL20T12_LT_Sh.png" />
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqHraK50SL20T0_LT_FlipFlop.png" alt="/req/ReqErrEqHraK50SL20T12_LT_Sh.png" />
\ No newline at end of file
diff --git a/docs/REQ/ReqAccuracyRandomShuffled.md b/docs/REQ/ReqAccuracyRandomShuffled.md
new file mode 100644
index 0000000..9a5d652
--- /dev/null
+++ b/docs/REQ/ReqAccuracyRandomShuffled.md
@@ -0,0 +1,96 @@
+---
+layout: doc_page
+---
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+# ReqSketch Accuracy with Random Shuffled Streams
+This set of tests characterize the accuracy of the ReqSketch using random shuffled streams.
+* [Code](https://github.com/apache/incubator-datasketches-characterization/blob/master/src/test/java/org/apache/datasketches/characterization/quantiles/ReqSketchAccuracyProfile.java): The code used to generate these characterization studies.
+* [Config](https://github.com/apache/incubator-datasketches-characterization/blob/master/src/main/resources/quantiles/ReqSketchAccuracyJob.conf): The human readable and editable configuration file that instructs the above code with the specific properties used to run the test. These configuration properties are different for each of the following plots and summarized below with each plot.
+
+
+## Test Design
+* Stream Length (SL): 2^20
+* Stream Values: Natural numbers, ℕ<sub>1</sub>, from 1 to SL, expressed as 32-bit floats.
+* Y-axis: The absolute error of the sketch *getRank(value)* method.
+* X-axis: The normalized rank [0.0, 1.0]
+* Plot Points (PP): 100. Equally spaced points along the X-axis starting at 0.0 and ending at 1.0.
+* Trial:
+ * Randomly Shuffles the input stream and presents it to the sketch.
+ * Executes *estRanks[] = getRanks(trueValues[])* from the sketch where the array of *trueValues[]* are the 100 equally spaced values along the x-axis that exactly correspond to the above Plot Points. The *estRanks[]* is the array of the sketch's estimates of the ranks of the given *trueValues*.
+ * Computes the absolute error: *estRanks[i] - trueRanks[i]* for each Plot Point and submits this error to a corresponding array of standard qantile sketches, with one quantile sketch assigned to each Plot Point.
+* Trials:
+ * 2^12 random trials are executed. This produces a distribution of error at each Plot Point held by the error quantile skeches.
+ * Extract 7 quantiles from the error quantile sketches at each Plot Point. These error quantiles correspond to the standard normal distribuion at the median, +/- 1SD, +/- 2SD and +/- 3SD, where SD stands for Standard Deviation from the mean.
+* Plotting:
+ * Each of the error quantiles are connected by lines to form contours of the error distribution where the area between the +/- 1SD contours is the size of the 68% confidence interval; between the +/- 2SD coutours is the 95.4% confidence interval; and between the +/- 3SD contours is the 99.7% confidence interval.
+ * In addition to the error contours. 6 dashed contours (with colors corresponding to the error contours) represent the a priori estimates of the error at each of the +/- standard deviations computed from the sketch's *getRankLowerBound(double, int)* and *getRankUpperBound(double, int)* methods.
+
+
+## Specific Configurations
+
+### Plot 1
+* K=12: the sketch sizing & accuracy parameter
+* SL=2^20: StreamLength
+* HRA: High Rank Accuracy
+* Eq Spaced: Equally spaced Plot Points (PP)
+* PP=100: Number of plot points on the x-axis
+* LgT=12: Number of trials = 2^12
+* Crit=LT: Comparison criterion: LT = Less-Than
+* Shuffled: Random shuffle of the input stream for each trial
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqHraK12SL20T12_LT_Sh.png" alt="/req/ReqErrEqHraK50SL20T12_LT_Sh.png" />
+
+### Plot 2
+* K=12: the sketch sizing & accuracy parameter
+* SL=2^20: StreamLength
+* LRA: Low Rank Accuracy
+* Eq Spaced: Equally spaced Plot Points (PP)
+* PP=100: Number of plot points on the x-axis
+* LgT=12: Number of trials = 2^12
+* Crit=LE: Comparison criterion: LE = Less-Than or Equal
+* Shuffled: Random shuffle of the input stream for each trial
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqLraK12SL20T12_LE_Sh.png" alt="/req/ReqErrEqLraK50SL20T12_LE_Sh.png" />
+
+### Plot 3
+* K=50: the sketch sizing & accuracy parameter
+* SL=2^20: StreamLength
+* HRA: High Rank Accuracy
+* Eq Spaced: Equally spaced Plot Points (PP)
+* PP=100: Number of plot points on the x-axis
+* LgT=12: Number of trials = 2^12
+* Crit=LT: Comparison criterion: LT = Less-Than
+* Shuffled: Random shuffle of the input stream for each trial
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqHraK50SL20T12_LT_Sh.png" alt="/req/ReqErrEqHraK50SL20T12_LT_Sh.png" />
+
+### Plot 4
+* K=50: the sketch sizing & accuracy parameter
+* SL=2^20: StreamLength
+* LRA: Low Rank Accuracy
+* Eq Spaced: Equally spaced Plot Points (PP)
+* PP=100: Number of plot points on the x-axis
+* LgT=12: Number of trials = 2^12
+* Crit=LE: Comparison criterion: LE = Less-Than or Equal
+* Shuffled: Random shuffle of the input stream for each trial
+
+<img class="doc-img-full" src="{{site.docs_img_dir}}/req/ReqErrEqLraK50SL20T12_LE_Sh.png" alt="/req/ReqErrEqLraK50SL20T12_LE_Sh.png" />
+
+
diff --git a/docs/img/req/ReqErrEqHraK12SL20T12_LT_Sh.png b/docs/img/req/ReqErrEqHraK12SL20T12_LT_Sh.png
new file mode 100644
index 0000000..79dd6bc
Binary files /dev/null and b/docs/img/req/ReqErrEqHraK12SL20T12_LT_Sh.png differ
diff --git a/docs/img/req/ReqErrEqHraK50SL20T0_LT_FlipFlop.png b/docs/img/req/ReqErrEqHraK50SL20T0_LT_FlipFlop.png
new file mode 100644
index 0000000..f960227
Binary files /dev/null and b/docs/img/req/ReqErrEqHraK50SL20T0_LT_FlipFlop.png differ
diff --git a/docs/img/req/ReqErrEqHraK50SL20T0_LT_Random.png b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Random.png
new file mode 100644
index 0000000..57838e9
Binary files /dev/null and b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Random.png differ
diff --git a/docs/img/req/ReqErrEqHraK50SL20T0_LT_Reversed.png b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Reversed.png
new file mode 100644
index 0000000..660f5a1
Binary files /dev/null and b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Reversed.png differ
diff --git a/docs/img/req/ReqErrEqHraK50SL20T0_LT_Sorted.png b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Sorted.png
new file mode 100644
index 0000000..6a30010
Binary files /dev/null and b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Sorted.png differ
diff --git a/docs/img/req/ReqErrEqHraK50SL20T0_LT_Sqrt.png b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Sqrt.png
new file mode 100644
index 0000000..9100654
Binary files /dev/null and b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Sqrt.png differ
diff --git a/docs/img/req/ReqErrEqHraK50SL20T0_LT_Zoomin.png b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Zoomin.png
new file mode 100644
index 0000000..0bdc9dc
Binary files /dev/null and b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Zoomin.png differ
diff --git a/docs/img/req/ReqErrEqHraK50SL20T0_LT_Zoomout.png b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Zoomout.png
new file mode 100644
index 0000000..b31b6ef
Binary files /dev/null and b/docs/img/req/ReqErrEqHraK50SL20T0_LT_Zoomout.png differ
diff --git a/docs/img/req/ReqErrEqHraK50SL20T12_LT_NoSh.png b/docs/img/req/ReqErrEqHraK50SL20T12_LT_NoSh.png
new file mode 100644
index 0000000..e15130a
Binary files /dev/null and b/docs/img/req/ReqErrEqHraK50SL20T12_LT_NoSh.png differ
diff --git a/docs/img/req/ReqErrEqHraK50SL20T12_LT_Sh.png b/docs/img/req/ReqErrEqHraK50SL20T12_LT_Sh.png
new file mode 100644
index 0000000..c6cc400
Binary files /dev/null and b/docs/img/req/ReqErrEqHraK50SL20T12_LT_Sh.png differ
diff --git a/docs/img/req/ReqErrEqLraK12SL20T12_LE_Sh.png b/docs/img/req/ReqErrEqLraK12SL20T12_LE_Sh.png
new file mode 100644
index 0000000..d5a9471
Binary files /dev/null and b/docs/img/req/ReqErrEqLraK12SL20T12_LE_Sh.png differ
diff --git a/docs/img/req/ReqErrEqLraK50SL20T12_LE_Sh.png b/docs/img/req/ReqErrEqLraK50SL20T12_LE_Sh.png
new file mode 100644
index 0000000..76dcecc
Binary files /dev/null and b/docs/img/req/ReqErrEqLraK50SL20T12_LE_Sh.png differ
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org