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/07/14 18:46:20 UTC

[incubator-datasketches-website] branch master updated: Add links to the Python install instructions so people can find them.

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 e11090c  Add links to the Python install instructions so people can find them.
e11090c is described below

commit e11090c5fccdcaa99e8c02f9bf34aec0a0c30dd9
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Tue Jul 14 11:45:55 2020 -0700

    Add links to the Python install instructions so people can find them.
---
 docs/Architecture/Components.md           | 2 +-
 docs/Architecture/KeyFeatures.md          | 2 +-
 docs/Architecture/SketchFeaturesMatrix.md | 3 ++-
 docs/Architecture/SketchesByComponent.md  | 5 ++---
 docs/Community/KDD_Tutorial_Summary.md    | 2 +-
 docs/Community/Transitioning.md           | 4 ++--
 docs/DistinctCountFeaturesMatrix.md       | 5 +++--
 docs/DistinctCountMeritComparisons.md     | 2 +-
 8 files changed, 13 insertions(+), 12 deletions(-)

diff --git a/docs/Architecture/Components.md b/docs/Architecture/Components.md
index 591064f..a530441 100644
--- a/docs/Architecture/Components.md
+++ b/docs/Architecture/Components.md
@@ -31,7 +31,7 @@ If you like what you see give us a **Star** on one of these two sites!
 
 * **[Java](https://github.com/apache/incubator-datasketches-java)** (Versioned, Apache Released) This is the original and the most comprehensive collection of sketch algorithms. It has a dependence on the Memory component and the Java Adaptors have a dependence on this component. 
 
-* **[C++/Python](https://github.com/apache/incubator-datasketches-cpp)** (Versioned, Apache Released) This is newer and provides most of the major algorithms available in Java.  Our C++ adaptors have a dependence on this component.  The Pybind adaptors for Python are included for all the C++ sketches.
+* **[C++](https://github.com/apache/incubator-datasketches-cpp)/[Python](https://github.com/apache/incubator-datasketches-cpp/tree/master/python)** (Versioned, Apache Released) This is newer and provides most of the major algorithms available in Java.  Our C++ adaptors have a dependence on this component.  The Pybind adaptors for Python are included for all the C++ sketches.
 
 ## Adapters
 Apapters integrate the core components into the aggregation APIs of specific data processing systems. Some of these adapters are available as part of the library, other adapters are directly integrated into the target data processing application.
diff --git a/docs/Architecture/KeyFeatures.md b/docs/Architecture/KeyFeatures.md
index 2a5816c..3851725 100644
--- a/docs/Architecture/KeyFeatures.md
+++ b/docs/Architecture/KeyFeatures.md
@@ -39,7 +39,7 @@ layout: doc_page
 <a href="https://search.maven.org/#search|ga|1|DataSketches">The Central Repository</a>.
 * Extensive documentation with the systems developer in mind.
 * Designed for production environments:
-    * Available in multiple languages: Java, C++, Python
+    * Available in multiple languages: Java, C++, [Python](https://github.com/apache/incubator-datasketches-cpp/tree/master/python)
     * Binary compatible across systems and languages 
 
 ### Built-In, General Purpose Functions
diff --git a/docs/Architecture/SketchFeaturesMatrix.md b/docs/Architecture/SketchFeaturesMatrix.md
index 01e7229..86d36d4 100644
--- a/docs/Architecture/SketchFeaturesMatrix.md
+++ b/docs/Architecture/SketchFeaturesMatrix.md
@@ -27,7 +27,7 @@ Use the following table to compare the capabilities of the different sketch fami
 <table>
 <tr style="font-weight:bold"><td colspan="2"></td><td colspan="3">Languages</td><td colspan="4">Set Operations</td><td colspan="5">System Integrations</td><td colspan="5">Misc.</td></tr>
 
-<tr style="font-weight:bold"><td>Type</td><td>Sketch</td><td>Java</td><td>C++</td><td>Python</td><td>Union</td><td>Inter-section</td><td>Difference</td><td>Jaccard</td><td>Hive</td><td>Pig</td><td>Druid<sup>1</sup></td><td>Spark<sup>2</sup></td><td>PostgreSQL (C++)</td><td>Con-current</td><td>Compact</td><td>Generic Types</td><td>Off Java Heap</td><td>Error Bounds</td></tr>
+<tr style="font-weight:bold"><td>Type</td><td>Sketch</td><td>Java</td><td>C++</td><td>Python<sup>7</sup></td><td>Union</td><td>Inter-section</td><td>Difference</td><td>Jaccard</td><td>Hive</td><td>Pig</td><td>Druid<sup>1</sup></td><td>Spark<sup>2</sup></td><td>PostgreSQL (C++)</td><td>Con-current</td><td>Compact</td><td>Generic Types</td><td>Off Java Heap</td><td>Error Bounds</td></tr>
 
 <tr style="font-weight:bold"><td colspan="19">Major Sketches</td></tr>
 <tr><td>Cardinality/CPC</td><td>CpcSketch</td><td>Y</td><td>Y</td><td>Y</td><td>Y</td><td></td><td></td><td></td><td>Y</td><td>Y</td><td></td><td></td><td>Y</td><td></td><td>Y</td><td></td><td></td><td>Y</td></tr>
@@ -63,6 +63,7 @@ Use the following table to compare the capabilities of the different sketch fami
 <sup>4</sup> Theta Sketch: C++/Python has no implementaion of the Jaccard, yet.<br>
 <sup>5</sup> Frequent Items Sketch: PostgreSQL implemented for Strings only.<br>
 <sup>6</sup> KLL Sketch: Python implemented for both just floats and ints.
+<sup>7</sup> See [Python Install Instructions](https://github.com/apache/incubator-datasketches-cpp/tree/master/python)
 
 
 ## Definitions
diff --git a/docs/Architecture/SketchesByComponent.md b/docs/Architecture/SketchesByComponent.md
index afa367d..37f5a24 100644
--- a/docs/Architecture/SketchesByComponent.md
+++ b/docs/Architecture/SketchesByComponent.md
@@ -127,15 +127,14 @@ org.apache.datasketches.characterization.uniquecount | Base Profiles for Unique
 This component implements the [Frequent Directions Algorithm](/docs/Community/Research.html) [GLP16].  It is still experimental in that the theoretical work has not yet supplied a suitable measure of error for production work. It can be used as is, but it will not go through a formal Apache Release until we can find a way to provide better error properties.  It has a dependence on the Memory component.
 
 
-## C++ and Python
+## C++ and [Python](https://github.com/apache/incubator-datasketches-cpp/tree/master/python)
 
 ### incubator-datasketches-cpp
 This is the evolving C++ implementations of the same sketches that are available in Java. 
 These implementations are *binary compatible* with their counterparts in Java.
 In other words, a sketch created and stored in C++ can be opened and read in Java and visa-versa.
 
-This site also has our Python adaptors that basically wrap the C++ implementations, 
-making the high performance C++ implementations available from Python.
+This site also has our [Python adaptors](https://github.com/apache/incubator-datasketches-cpp/tree/master/python) that basically wrap the C++ implementations, making the high performance C++ implementations available from Python.
 
 ### incubator-datasketches-postgresql
 This site provides the postgres-specific adaptors that wrap the C++ implementations making
diff --git a/docs/Community/KDD_Tutorial_Summary.md b/docs/Community/KDD_Tutorial_Summary.md
index b94bdfa..59c9b59 100644
--- a/docs/Community/KDD_Tutorial_Summary.md
+++ b/docs/Community/KDD_Tutorial_Summary.md
@@ -98,7 +98,7 @@ The audience should learn about
         2. Accepting approximation
         3. Understanding error
         4. System planning
-    4. Demonstration in python
+    4. Demonstration in [Python](https://github.com/apache/incubator-datasketches-cpp/tree/master/python)
         1. Examples of several sketches
         2. Deeper dive with sampling
 4. Extra topics (Time permitting) (10 minutes)
diff --git a/docs/Community/Transitioning.md b/docs/Community/Transitioning.md
index d5a3894..de46f4e 100644
--- a/docs/Community/Transitioning.md
+++ b/docs/Community/Transitioning.md
@@ -46,7 +46,7 @@ View all of our Apache DataSketches repository components as a [list](https://gi
   * **sketches-vector** moved to [incubator-datasketches-vector](https://github.com/apache/incubator-datasketches-vector) Experimental sketches for vector and matrix processing.
   * [Apache Druid adaptors](https://github.com/apache/druid/tree/master/extensions-core/datasketches)
 
-* C++ / Python Core
+* C++ / [Python](https://github.com/apache/incubator-datasketches-cpp/tree/master/python) Core
   * **sketches-core-cpp** moved to [incubator-datasketches-cpp](https://github.com/apache/incubator-datasketches-cpp) This is the **core** library that contains all major sketch algorithms written in C++ and Python.
 
 * C++ Adaptors
@@ -62,7 +62,7 @@ View all of our Apache DataSketches repository components as a [list](https://gi
   * [characterization-cpp](https://github.com/DataSketches/characterization-cpp)
   * [experimental-cpp](https://github.com/DataSketches/experimental-cpp)
 
-* Command Line Functions (Mostly obsolete. These may move to Apache later or replaced by Python) 
+* Command Line Functions (Mostly obsolete. These may move to Apache later or replaced by [Python](https://github.com/apache/incubator-datasketches-cpp/tree/master/python)) 
   * [homebrew-sketches-cmd](https://github.com/DataSketches/homebrew-sketches-cmd)
   * [sketches-cmd](https://github.com/DataSketches/sketches-cmd)
   * [homebrew-sketches](https://github.com/DataSketches/homebrew-sketches)
diff --git a/docs/DistinctCountFeaturesMatrix.md b/docs/DistinctCountFeaturesMatrix.md
index a882386..015d76a 100644
--- a/docs/DistinctCountFeaturesMatrix.md
+++ b/docs/DistinctCountFeaturesMatrix.md
@@ -61,7 +61,7 @@ Deserialize Operations | Heapify() | Y | Y | Y | Y |
  | WritableWrap | Y | Y | Y |  |
 Languages | Java | Y | Y | Y | Y |
  | C++ | Y |  | Y | Y |
- | Python | Y |  | Y | Y |
+ | Python<sup>2</sup> | Y |  | Y | Y |
  | Binary compatibility across Languages | Y | Y | Y | Y |
 Other Operations and Modes | Jaccard Index | Y |  |  |  |
  | Off-Heap | Y | Y | Y |
@@ -69,6 +69,7 @@ Other Operations and Modes | Jaccard Index | Y |  |  |  |
  | Generic Extensions  |  | Y |  |  |
  
 ____
- 1. Space Accuracy Merit (Lower is better) = b * C^2 = b * K * RSE^2 
+ <sup>1</sup> Space Accuracy Merit (Lower is better) = b * C^2 = b * K * RSE^2<br>
+ <sup>2</sup> See [Python Install Instructions](https://github.com/apache/incubator-datasketches-cpp/tree/master/python)<br>
 
  
\ No newline at end of file
diff --git a/docs/DistinctCountMeritComparisons.md b/docs/DistinctCountMeritComparisons.md
index e08b077..f9c53d9 100644
--- a/docs/DistinctCountMeritComparisons.md
+++ b/docs/DistinctCountMeritComparisons.md
@@ -98,4 +98,4 @@ In order to generate the following radar charts, the data was normalized as foll
 
 Depending on what is important in your environment you should choose the sketch that best suits your needs. 
 
-Note that all of these tests were performed with the Java implementations of these sketches.  The results for C++ or Python may be completely different.
\ No newline at end of file
+Note that all of these tests were performed with the Java implementations of these sketches.  The results for C++ or [Python](https://github.com/apache/incubator-datasketches-cpp/tree/master/python) may be completely different.
\ No newline at end of file


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org