You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by ze...@apache.org on 2020/04/11 22:07:42 UTC

[incubator-streampipes-extensions] 01/05: Add documentation for statistiics processors

This is an automated email from the ASF dual-hosted git repository.

zehnder pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-extensions.git

commit f88ac8c13708165e90da7877f4b763737649214c
Author: Philipp Zehnder <ze...@fzi.de>
AuthorDate: Sat Apr 11 23:02:20 2020 +0200

    Add documentation for statistiics processors
---
 .../documentation.md                               | 29 +++++++++++-----------
 .../documentation.md                               | 25 ++++++-------------
 2 files changed, 22 insertions(+), 32 deletions(-)

diff --git a/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md b/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary-window/documentation.md
similarity index 69%
copy from streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md
copy to streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary-window/documentation.md
index 5b99a47..bd20e46 100644
--- a/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md
+++ b/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary-window/documentation.md
@@ -16,7 +16,7 @@
   ~
   -->
 
-## Statistics Summary
+## Sliding Statistics Summary
 
 <p align="center"> 
     <img src="icon.png" width="150px;" class="pe-image-documentation"/>
@@ -26,23 +26,24 @@
 
 ## Description
 
-Calculate simple descriptive summary statistics
-Add a detailed description here
+Calculate simple descriptive summary statistics for a selected property over a defined time interval.
 
 ***
 
 ## Required input
-
-
-***
+Requires a numerical property
 
 ## Configuration
 
-Describe the configuration parameters here
-
-### 1st parameter
-
-
-### 2nd parameter
-
-## Output
\ No newline at end of file
+* Define a value to observe
+* Select the time field
+* Group the event streams by an identifier
+* Set the time window size and scale (Seconds, Minutes, Hours)
+
+## Output
+The statistics are appended to the event and contain:
+* Minimum
+* Maximum
+* Sum
+* Standard Deviation
+* Variance
diff --git a/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md b/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md
index 5b99a47..59e9dbe 100644
--- a/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md
+++ b/streampipes-processors-statistics-flink/src/main/resources/org.apache.streampipes.processors.statistics.flink.statistics-summary/documentation.md
@@ -26,23 +26,12 @@
 
 ## Description
 
-Calculate simple descriptive summary statistics
-Add a detailed description here
+Calculate simple descriptive summary statistics for each selected list property.
 
-***
-
-## Required input
-
-
-***
-
-## Configuration
-
-Describe the configuration parameters here
-
-### 1st parameter
-
-
-### 2nd parameter
+The statistics contain:
+* Minimum
+* Maximum
+* Sum
+* Standard Deviation
+* Variance
 
-## Output
\ No newline at end of file