You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by al...@apache.org on 2024/09/27 23:14:04 UTC
(datasketches-bigquery) 01/01: minimalistic descriptions in subdirs to get started
This is an automated email from the ASF dual-hosted git repository.
alsay pushed a commit to branch readme
in repository https://gitbox.apache.org/repos/asf/datasketches-bigquery.git
commit a3978520e3da550c98cc29d47f4a1ff28cb1451e
Author: AlexanderSaydakov <Al...@users.noreply.github.com>
AuthorDate: Fri Sep 27 16:13:39 2024 -0700
minimalistic descriptions in subdirs to get started
---
cpc/README.md | 27 +++------------------------
hll/README.md | 18 +++---------------
kll/README.md | 27 +++------------------------
theta/README.md | 27 +++------------------------
{hll => tuple}/README.md | 18 +++---------------
5 files changed, 15 insertions(+), 102 deletions(-)
diff --git a/cpc/README.md b/cpc/README.md
index 866a930..6c6a790 100644
--- a/cpc/README.md
+++ b/cpc/README.md
@@ -17,28 +17,7 @@
under the License.
-->
-# Apache DataSketches functions for Google Cloud BigQuery
+# Compressed Probability Counting (CPC) Sketches
+Functions for distinct counting based on [CPC sketches](https://datasketches.apache.org/docs/CPC/CpcSketches.html)
-[User-Defined Aggregate Functions (UDAFs)](https://cloud.google.com/bigquery/docs/user-defined-aggregates) and
-[non-aggregate (scalar) functions (UDFs)](https://cloud.google.com/bigquery/docs/user-defined-functions) for BigQuery SQL engine.
-
-Please visit the main [Apache DataSketches website](https://datasketches.apache.org) for more information about DataSketches library.
-
-If you are interested in making contributions to this project please see our [Community](https://datasketches.apache.org/docs/Community/) page for how to contact us.
-
-## Building
-
-- Requires [Emscripten (emcc compiler)](https://emscripten.org/)
-- Requires a link to [datasketches-cpp](https://github.com/apache/datasketches-cpp) in this directory
-
-## Example
-
- select `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_get_estimate(
- `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_scalar_union(
- (select `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_agg_string(value, struct<int, int64>(null, null)) from unnest(["1", "2", "3"]) as value),
- (select `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_agg_string(value, struct<int, int64>(null, null)) from unnest(["3", "4", "5"]) as value),
- null, null
- ), null
- );
-
- result: 5
+See tests for usage examples.
diff --git a/hll/README.md b/hll/README.md
index daf02ba..28151a5 100644
--- a/hll/README.md
+++ b/hll/README.md
@@ -17,19 +17,7 @@
under the License.
-->
-# Apache DataSketches functions for Google Cloud BigQuery
+# HyperLogLog (HLL) Sketches
+Functions for distinct counting based on [HLL sketches](https://datasketches.apache.org/docs/HLL/HllSketches.html)
-Functions to support HLL sketch and union operations.
-
-## Example
-
- select t.hll_sketch_get_estimate(
- t.hll_sketch_scalar_union(
- (select t.hll_sketch_agg_string(str, struct<int, string>(10, "HLL_8")) from unnest(["a", "b", "c"]) as str),
- (select t.hll_sketch_agg_string(str, struct<int, string>(10, "HLL_8")) from unnest(["c", "d", "e"]) as str),
- 10,
- "HLL_8"
- )
- );
-
- result: 5
+See tests for usage examples.
diff --git a/kll/README.md b/kll/README.md
index 866a930..7e3f80b 100644
--- a/kll/README.md
+++ b/kll/README.md
@@ -17,28 +17,7 @@
under the License.
-->
-# Apache DataSketches functions for Google Cloud BigQuery
+# KLL Sketches
+Functions for estimating distributions, quantiles and ranks based on [KLL sketches](https://datasketches.apache.org/docs/KLL/KLLSketch.html)
-[User-Defined Aggregate Functions (UDAFs)](https://cloud.google.com/bigquery/docs/user-defined-aggregates) and
-[non-aggregate (scalar) functions (UDFs)](https://cloud.google.com/bigquery/docs/user-defined-functions) for BigQuery SQL engine.
-
-Please visit the main [Apache DataSketches website](https://datasketches.apache.org) for more information about DataSketches library.
-
-If you are interested in making contributions to this project please see our [Community](https://datasketches.apache.org/docs/Community/) page for how to contact us.
-
-## Building
-
-- Requires [Emscripten (emcc compiler)](https://emscripten.org/)
-- Requires a link to [datasketches-cpp](https://github.com/apache/datasketches-cpp) in this directory
-
-## Example
-
- select `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_get_estimate(
- `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_scalar_union(
- (select `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_agg_string(value, struct<int, int64>(null, null)) from unnest(["1", "2", "3"]) as value),
- (select `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_agg_string(value, struct<int, int64>(null, null)) from unnest(["3", "4", "5"]) as value),
- null, null
- ), null
- );
-
- result: 5
+See tests for usage examples.
diff --git a/theta/README.md b/theta/README.md
index 866a930..bc9c1db 100644
--- a/theta/README.md
+++ b/theta/README.md
@@ -17,28 +17,7 @@
under the License.
-->
-# Apache DataSketches functions for Google Cloud BigQuery
+# Theta Sketches
+Functions for distinct counting and set operations based on [Theta sketches](https://datasketches.apache.org/docs/Theta/ThetaSketches.html)
-[User-Defined Aggregate Functions (UDAFs)](https://cloud.google.com/bigquery/docs/user-defined-aggregates) and
-[non-aggregate (scalar) functions (UDFs)](https://cloud.google.com/bigquery/docs/user-defined-functions) for BigQuery SQL engine.
-
-Please visit the main [Apache DataSketches website](https://datasketches.apache.org) for more information about DataSketches library.
-
-If you are interested in making contributions to this project please see our [Community](https://datasketches.apache.org/docs/Community/) page for how to contact us.
-
-## Building
-
-- Requires [Emscripten (emcc compiler)](https://emscripten.org/)
-- Requires a link to [datasketches-cpp](https://github.com/apache/datasketches-cpp) in this directory
-
-## Example
-
- select `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_get_estimate(
- `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_scalar_union(
- (select `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_agg_string(value, struct<int, int64>(null, null)) from unnest(["1", "2", "3"]) as value),
- (select `$BQ_PROJECT.$BQ_DATASET`.theta_sketch_agg_string(value, struct<int, int64>(null, null)) from unnest(["3", "4", "5"]) as value),
- null, null
- ), null
- );
-
- result: 5
+See tests for usage examples.
diff --git a/hll/README.md b/tuple/README.md
similarity index 63%
copy from hll/README.md
copy to tuple/README.md
index daf02ba..187c9df 100644
--- a/hll/README.md
+++ b/tuple/README.md
@@ -17,19 +17,7 @@
under the License.
-->
-# Apache DataSketches functions for Google Cloud BigQuery
+# Tuple Sketches
+Functions for distinct counting, set operations, subset sampling and other various applications based on [Tuple sketches](https://datasketches.apache.org/docs/Tuple/TupleSketches.html)
-Functions to support HLL sketch and union operations.
-
-## Example
-
- select t.hll_sketch_get_estimate(
- t.hll_sketch_scalar_union(
- (select t.hll_sketch_agg_string(str, struct<int, string>(10, "HLL_8")) from unnest(["a", "b", "c"]) as str),
- (select t.hll_sketch_agg_string(str, struct<int, string>(10, "HLL_8")) from unnest(["c", "d", "e"]) as str),
- 10,
- "HLL_8"
- )
- );
-
- result: 5
+See tests for usage examples.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org