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 2024/09/23 17:31:58 UTC
(datasketches-website) 01/01: Before I can do the same update to the quantiles directories
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch cleanup_quantiles_directories_plus_misc
in repository https://gitbox.apache.org/repos/asf/datasketches-website.git
commit 53b43579f99172a3a817dc5aa08df34c365cc53f
Author: Lee Rhodes <le...@gmail.com>
AuthorDate: Mon Sep 23 10:31:43 2024 -0700
Before I can do the same update to the quantiles directories
I need to do some cleanup that I should have done ages ago:
- The /docs/Quantiles/ directory had a mishmash of docs that applied to
all Q sketches plus historical docs about the Classic Q sketches.
- So I moved 3 "general" files into a new directory /docs/QuantilesAll/
- I went through all the *.md files on the website that referred to
these files and corrected the references -- there were just a few.
- I will search the source of our other repos to fix any references
there, if there are any.
---
_includes/toc.html | 6 +++---
docs/Architecture/MajorSketchFamilies.md | 4 ++--
docs/Quantiles/ClassicQuantilesSketch.md | 2 +-
docs/{Quantiles => QuantilesAll}/QuantilesOverview.md | 19 ++++++++++---------
.../QuantilesReferences.md | 0
.../SketchingQuantilesAndRanksTutorial.md | 0
docs/QuantilesStudies/DruidApproxHistogramStudy.md | 2 +-
docs/QuantilesStudies/MomentsSketchStudy.md | 2 +-
docs/QuantilesStudies/QuantilesStreamAStudy.md | 2 +-
pom.xml | 1 +
src/main/resources/docgen/toc.json | 18 +++++++++---------
11 files changed, 29 insertions(+), 27 deletions(-)
diff --git a/_includes/toc.html b/_includes/toc.html
index 609aa7bb..86dd5e46 100644
--- a/_includes/toc.html
+++ b/_includes/toc.html
@@ -67,8 +67,8 @@
<a data-toggle="collapse" class="menu collapsed" href="#collapse_quantiles_and_histograms">Quantiles And Histograms</a>
</p>
<div class="collapse" id="collapse_quantiles_and_histograms">
- <li><a href="{{site.docs_dir}}/Quantiles/SketchingQuantilesAndRanksTutorial.html">•Quantiles and Ranks Tutorial</a></li>
- <li><a href="{{site.docs_dir}}/Quantiles/QuantilesOverview.html">•Quantiles Overview</a></li>
+ <li><a href="{{site.docs_dir}}/QuantilesAll/SketchingQuantilesAndRanksTutorial.html">•Quantiles and Ranks Tutorial</a></li>
+ <li><a href="{{site.docs_dir}}/QuantilesAll/QuantilesOverview.html">•Quantiles Overview</a></li>
<li><a href="{{site.docs_dir}}/KLL/KLLSketch.html">•KLL Sketch Family</a></li>
<li><a href="{{site.docs_dir}}/KLL/KLLAccuracyAndSize.html">•KLL Sketch Accuracy and Size</a></li>
<li><a href="{{site.docs_dir}}/KLL/UnderstandingKLLBounds.html">•Understanding KLL Bounds</a></li>
@@ -100,7 +100,7 @@
</p>
<div class="collapse" id="collapse_quantiles_sketch_theory">
<li><a href="{{site.docs_pdf_dir}}/Quantiles_KLL.pdf">•Optimal Quantile Approximation in Streams</a></li>
- <li><a href="{{site.docs_dir}}/Quantiles/QuantilesReferences.html">•Quantiles References</a></li>
+ <li><a href="{{site.docs_dir}}/QuantilesAll/QuantilesReferences.html">•Quantiles References</a></li>
</div>
</div>
diff --git a/docs/Architecture/MajorSketchFamilies.md b/docs/Architecture/MajorSketchFamilies.md
index 9116ab53..56a5538e 100644
--- a/docs/Architecture/MajorSketchFamilies.md
+++ b/docs/Architecture/MajorSketchFamilies.md
@@ -62,8 +62,8 @@ This is a specially designed sketch that addresses the problem of individually t
## Quantiles Sketches
-### [Quantiles Sketches]({{site.docs_dir}}/Quantiles/QuantilesOverview.html): Estimating Distributions from a Stream of Values
-There are many situations where is valuable to understand the distribution of values in a stream. For example, from a stream of web-page time-spent values, it would be useful to know arbitrary quantiles of the distribution, such as the 25th percentile value, the median value and the 75th percentile value. The [Quantiles Sketches]({{site.docs_dir}}/Quantiles/QuantilesOverview.html) solve this problem and enable the inverse functions such as the Probability Mass Function (PMF) and the Cumu [...]
+### [Quantiles Sketches]({{site.docs_dir}}/QuantilesAll/QuantilesOverview.html): Estimating Distributions from a Stream of Values
+There are many situations where is valuable to understand the distribution of values in a stream. For example, from a stream of web-page time-spent values, it would be useful to know arbitrary quantiles of the distribution, such as the 25th percentile value, the median value and the 75th percentile value. The [Quantiles Sketches]({{site.docs_dir}}/QuantilesAll/QuantilesOverview.html) solve this problem and enable the inverse functions such as the Probability Mass Function (PMF) and the C [...]
<img class="doc-img-full" src="{{site.docs_img_dir}}/quantiles/TimeSpentHistogram.png" alt="TimeSpentHistogram" />
diff --git a/docs/Quantiles/ClassicQuantilesSketch.md b/docs/Quantiles/ClassicQuantilesSketch.md
index a27e44b8..cc2931f8 100644
--- a/docs/Quantiles/ClassicQuantilesSketch.md
+++ b/docs/Quantiles/ClassicQuantilesSketch.md
@@ -22,7 +22,7 @@ layout: doc_page
# Classic Quantiles Sketch
## Quantiles Sketches Accuracy and Size
-Please review the Quantiles [Tutorial]({{site.docs_dir}}/Quantiles/SketchingQuantilesAndRanksTutorial.html).
+Please review the Quantiles [Tutorial]({{site.docs_dir}}/QuantilesAll/SketchingQuantilesAndRanksTutorial.html).
The accuracy of a quantile sketch is a function of the configured value <i>k</i>, which also affects
the overall size of the sketch.
diff --git a/docs/Quantiles/QuantilesOverview.md b/docs/QuantilesAll/QuantilesOverview.md
similarity index 96%
rename from docs/Quantiles/QuantilesOverview.md
rename to docs/QuantilesAll/QuantilesOverview.md
index e059944e..68fc3682 100644
--- a/docs/Quantiles/QuantilesOverview.md
+++ b/docs/QuantilesAll/QuantilesOverview.md
@@ -48,12 +48,12 @@ These sketches have many parallel methods. Please refer to the sketch API docume
### The Classic Quantiles Sketch
* Java
- * Release 0.3.0, 25 Jan 2016
* Repo: <https://github.com/apache/datasketches-java>
* Package: org.apache.datasketches.quantiles
-* C++, Python
- * Release 1.0.0, 17 Sep 2019
+* C++
* Repo: <https://github.com/apache/datasketches-cpp>
+* Python
+ * Repo: <https://github.com/apache/datasketches-python>
* Key Features (both Java & C++)
* User selectable search criteria QuantileSearchCriteria:
* Exclusive, which is compatible with the KLL and older Quantiles Sketch
@@ -66,13 +66,13 @@ These sketches have many parallel methods. Please refer to the sketch API docume
### The KLL Sketch
* Java
- * Release 0.11.0, 15 Mar 2018
* Repo: <https://github.com/apache/datasketches-java>:
* Package: org.apache.datasketches.kll
-* C++, Python
- * Release 1.0.0, 17 Sep 2019
+* C++
* Repo: <https://github.com/apache/datasketches-cpp>
* Directory: kll
+* Python
+ * Repo: <https://github.com/apache/datasketches-python>
* Key Features (both Java & C++)
* User selectable comparison QuantileSearchCriteria:
* Exclusive, which is compatible with the KLL and older Quantiles Sketch
@@ -87,13 +87,14 @@ These sketches have many parallel methods. Please refer to the sketch API docume
### The REQ Sketch
* Java
- * Release 2.0.0, 12 Feb 2021
* Repo: <https://github.com/apache/datasketches-java>
* Package: org.apache.datasketches.req
-* C++, Python
- * Release 2.2.0, Soon
+* C++
* Repo: <https://github.com/apache/datasketches-cpp>
* Directory: req
+* Python
+ * Repo: <https://github.com/apache/datasketches-python>
+
* Key Features (both Java & C++)
* Accuracy %: a function of *K* and **relative** with respect to rank. The user can select either High Rank Accuracy (HRA) or Low Rank Accuracy (LRA). This enables extremely high accuracy for the ends of the rank domain. E.g., 99.999%ile quantiles.
* User selectable comparison QuantileSearchCriteria:
diff --git a/docs/Quantiles/QuantilesReferences.md b/docs/QuantilesAll/QuantilesReferences.md
similarity index 100%
rename from docs/Quantiles/QuantilesReferences.md
rename to docs/QuantilesAll/QuantilesReferences.md
diff --git a/docs/Quantiles/SketchingQuantilesAndRanksTutorial.md b/docs/QuantilesAll/SketchingQuantilesAndRanksTutorial.md
similarity index 100%
rename from docs/Quantiles/SketchingQuantilesAndRanksTutorial.md
rename to docs/QuantilesAll/SketchingQuantilesAndRanksTutorial.md
diff --git a/docs/QuantilesStudies/DruidApproxHistogramStudy.md b/docs/QuantilesStudies/DruidApproxHistogramStudy.md
index 7efd7f59..a64a440f 100644
--- a/docs/QuantilesStudies/DruidApproxHistogramStudy.md
+++ b/docs/QuantilesStudies/DruidApproxHistogramStudy.md
@@ -23,7 +23,7 @@ layout: doc_page
The goal of this article is to compare the accuracy performance of the Druid built-in Approximate Histogram to an exact, brute-force computation using actual data extracted from one of our back-end servers.
-Please get familiar with the [Tutorial]({{site.docs_dir}}/Quantiles/SketchingQuantilesAndRanksTutorial.html) for quantiles.
+Please get familiar with the [Tutorial]({{site.docs_dir}}/QuantilesAll/SketchingQuantilesAndRanksTutorial.html) for quantiles.
Compare this study with the DataSketches [Quantiles StreamA Study](/docs/QuantilesStudies/QuantilesStreamAStudy.html) with the same input data.
diff --git a/docs/QuantilesStudies/MomentsSketchStudy.md b/docs/QuantilesStudies/MomentsSketchStudy.md
index 69011144..1b6be059 100644
--- a/docs/QuantilesStudies/MomentsSketchStudy.md
+++ b/docs/QuantilesStudies/MomentsSketchStudy.md
@@ -23,7 +23,7 @@ layout: doc_page
The goal of this article is to compare the accuracy performance of the Moments Sketch to an exact, brute-force computation using actual data extracted from one of our back-end servers.
-Please get familiar with the [Tutorial]({{site.docs_dir}}/Quantiles/SketchingQuantilesAndRanksTutorial.html) for quantiles.
+Please get familiar with the [Tutorial]({{site.docs_dir}}/QuantilesAll/SketchingQuantilesAndRanksTutorial.html) for quantiles.
Compare this study with the DataSketches [Quantiles StreamA Study](/docs/QuantilesStudies/QuantilesStreamAStudy.html) with the same input data.
diff --git a/docs/QuantilesStudies/QuantilesStreamAStudy.md b/docs/QuantilesStudies/QuantilesStreamAStudy.md
index b2f4a288..d93649c2 100644
--- a/docs/QuantilesStudies/QuantilesStreamAStudy.md
+++ b/docs/QuantilesStudies/QuantilesStreamAStudy.md
@@ -23,7 +23,7 @@ layout: doc_page
The goal of this article is to compare the accuracy performance of the DataSketches Quantiles Sketch to an exact, brute-force computation using actual data extracted from one of our back-end servers.
-Please get familiar with the [Tutorial]({{site.docs_dir}}/Quantiles/SketchingQuantilesAndRanksTutorial.html) for quantiles.
+Please get familiar with the [Tutorial]({{site.docs_dir}}/QuantilesAll/SketchingQuantilesAndRanksTutorial.html) for quantiles.
## Versions
diff --git a/pom.xml b/pom.xml
index f13d337e..158c122e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -286,6 +286,7 @@ under the License.
<exclude>**/*.ipynb</exclude>
<exclude>**/package-list</exclude>
<exclude>**/*.svg</exclude>
+ <exclude>**/*.rdf</exclude>
<!-- END: UNIQUE FOR THIS JAVA COMPONENT -->
<exclude>**/test/resources/**/*.txt</exclude>
<exclude>.asf.yaml</exclude>
diff --git a/src/main/resources/docgen/toc.json b/src/main/resources/docgen/toc.json
index 584597b4..4e08c4c9 100644
--- a/src/main/resources/docgen/toc.json
+++ b/src/main/resources/docgen/toc.json
@@ -34,12 +34,12 @@
[
{ "class":"Dropdown", "desc" : "Distinct Counting", "array":
[
- {"class":"Doc", "desc" : "Features Matrix", "dir" : "", "file": "DistinctCountFeaturesMatrix" },
- {"class":"Doc", "desc" : "Figures-of-Merit Comparison", "dir" : "", "file": "DistinctCountMeritComparisons"},
- { "class":"Doc", "desc" : "CPC Sketches", "dir" : "CPC", "file": "CpcSketches" },
- { "class":"Doc", "desc" : "HyperLogLog Sketches", "dir" : "HLL", "file": "HllSketches" },
- { "class":"Doc", "desc" : "Theta Sketches", "dir" : "Theta", "file": "ThetaSketches" },
- { "class":"Doc", "desc" : "Tuple Sketches", "dir" : "Tuple", "file": "TupleSketches" },
+ {"class":"Doc", "desc" : "Features Matrix", "dir" : "", "file": "DistinctCountFeaturesMatrix" },
+ {"class":"Doc", "desc" : "Figures-of-Merit Comparison", "dir" : "", "file": "DistinctCountMeritComparisons" },
+ {"class":"Doc", "desc" : "CPC Sketches", "dir" : "CPC", "file": "CpcSketches" },
+ {"class":"Doc", "desc" : "HyperLogLog Sketches", "dir" : "HLL", "file": "HllSketches" },
+ {"class":"Doc", "desc" : "Theta Sketches", "dir" : "Theta", "file": "ThetaSketches" },
+ {"class":"Doc", "desc" : "Tuple Sketches", "dir" : "Tuple", "file": "TupleSketches" },
]
},
@@ -53,8 +53,8 @@
{ "class":"Dropdown", "desc" : "Quantiles And Histograms", "array":
[
- {"class":"Doc", "desc" : "Quantiles and Ranks Tutorial", "dir" : "Quantiles", "file": "SketchingQuantilesAndRanksTutorial"},
- {"class":"Doc", "desc" : "Quantiles Overview", "dir" : "Quantiles", "file": "QuantilesOverview" },
+ {"class":"Doc", "desc" : "Quantiles and Ranks Tutorial", "dir" : "QuantilesAll", "file": "SketchingQuantilesAndRanksTutorial"},
+ {"class":"Doc", "desc" : "Quantiles Overview", "dir" : "QuantilesAll", "file": "QuantilesOverview" },
{"class":"Doc", "desc" : "KLL Sketch Family", "dir" : "KLL", "file": "KLLSketch" },
{"class":"Doc", "desc" : "KLL Sketch Accuracy and Size", "dir" : "KLL", "file": "KLLAccuracyAndSize" },
{"class":"Doc", "desc" : "Understanding KLL Bounds", "dir" : "KLL", "file": "UnderstandingKLLBounds" },
@@ -80,7 +80,7 @@
{ "class":"Dropdown", "desc" : "Quantiles Sketch Theory", "array":
[
{"class":"Doc", "desc" : "Optimal Quantile Approximation in Streams", "dir" : "", "file": "Quantiles_KLL", "pdf":"true" },
- {"class":"Doc", "desc" : "Quantiles References", "dir" : "Quantiles", "file": "QuantilesReferences" },
+ {"class":"Doc", "desc" : "Quantiles References", "dir" : "QuantilesAll", "file": "QuantilesReferences" },
]
},
]
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org