Refact: Consolidation of native streams #916

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/streams/stream_pool_objects/01_native_streams.rst

@@ -2,7 +2,7 @@
 Native Streams
 ==============
 
-Along with third party stream support, MLPro also provides pool of native stream objects. The native streams in MLPro
+Along with third party stream support, MLPro also provides a pool of native stream objects. The native streams in MLPro
 include the following implementations.
 
 .. toctree::
@@ -13,8 +13,8 @@ include the following implementations.
 
 
 
-Cross Reference:
- + :ref:`Howto BF-STREAMS-001: Accessing Native Data From MLPro <Howto_BF_ZZ_999>`
- + :ref:`API Reference: Streams <target_ap_bf_streams>`
+**Cross Reference**
+   - :ref:`Howto BF-STREAMS-001: Accessing Native Data From MLPro <Howto_BF_STREAMS_001>`
+   - :ref:`API Reference: Streams <target_ap_bf_streams>`
 
 

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/streams/stream_pool_objects/native_streams/07_csv_stream.rst → doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/streams/stream_pool_objects/native_streams/001_csv_stream.rst

@@ -1,11 +1,12 @@
 Data from CSV Files
 --------------------
+
 .. automodule:: mlpro.bf.streams.streams.csv_file
 
 .. image::
     images/csv_files.png
-    :width: 600px
+    :width: 400px
 
-**Cross References**
 
- + :ref:`Howto BF-STREAMS-002: Accessing Data From CSV Files <Howto_BF_STREAMS_002>`
+**Cross References**
+    - :ref:`Howto BF-STREAMS-002: Accessing Data From CSV Files <Howto_BF_STREAMS_002>`

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/streams/stream_pool_objects/native_streams/002_random10d.rst

@@ -0,0 +1,13 @@
+Random 10-Dimensional
+---------------------
+
+.. automodule:: mlpro.bf.streams.streams.rnd10d
+
+
+.. image::
+    images/Rnd10Dx1000.gif
+    :width: 400px
+
+
+**Cross References**
+    - :ref:`Howto BF-STREAMS-003: Visualizing 10-dimensional Random Stream Provided By MLPro <Howto_BF_STREAMS_003>`    

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/streams/stream_pool_objects/native_streams/003_double_spiral_2d.rst

@@ -0,0 +1,13 @@
+2D Double Spiral
+----------------
+
+.. automodule:: mlpro.bf.streams.streams.double_spiral
+
+
+.. image::
+    images/double_spiral.gif
+    :width: 400px
+
+
+**Cross References**
+    - :ref:`Howto BF-STREAMS-004: Visualizing 2D Double Spiral Stream Provided By MLPro <Howto_BF_STREAMS_004>`    

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/streams/stream_pool_objects/native_streams/004_point_outliers.rst

@@ -0,0 +1,13 @@
+Point Outliers
+--------------
+
+.. automodule:: mlpro.bf.streams.streams.point_outliers
+
+
+.. image::
+    images/point_outliers.gif
+    :width: 400px
+
+
+**Cross Reference**
+   - :ref:`Howto BF-STREAMS-005: Visualizing Multivariate Point Outlier Stream Provided By MLPro <Howto_BF_STREAMS_005>`

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/streams/stream_pool_objects/native_streams/005_random_clouds.rst

@@ -0,0 +1,35 @@
+Random Point Clouds (2D, 3D, ND), Static or Dynamic
+---------------------------------------------------
+.. automodule:: mlpro.bf.streams.streams.clouds
+
+2D random clouds...
+
+.. image::
+    images/cloud01.gif
+    :width: 400px
+
+.. image::
+    images/cloud02.gif
+    :width: 400px
+
+3D random clouds...
+
+.. image::
+    images/cloud03.gif
+    :width: 400px
+
+.. image::
+    images/cloud04.gif
+    :width: 400px
+
+.. image::
+    images/cloud05.gif
+    :width: 400px
+
+
+**Cross Reference**
+   - :ref:`Howto BF-STREAMS-006: Visualizing Static 2D Random Point Clouds Provided By MLPro <Howto_BF_STREAMS_006>`
+   - :ref:`Howto BF-STREAMS-007: Visualizing Dynamic 2D Random Point Clouds Provided By MLPro <Howto_BF_STREAMS_007>`
+   - :ref:`Howto BF-STREAMS-008: Visualizing Static 3D Random Point Clouds Provided By MLPro <Howto_BF_STREAMS_008>`
+   - :ref:`Howto BF-STREAMS-009: Visualizing Dynamic 3D Random Point Clouds Provided By MLPro <Howto_BF_STREAMS_009>`
+   - :ref:`Howto BF-STREAMS-010: Visualizing Multivariate Random Cloud Generator in 3D Mode Provided By MLPro <Howto_BF_STREAMS_010>`

doc/rtd/content/99_appendices/appendix1/sub/mlpro_bf/layer3_application_support/streams/howto.bf.streams.001.rst

@@ -18,5 +18,4 @@ Howto BF-STREAMS-001: Accessing Native Data From MLPro
 
 
 **Cross Reference**
-
     - :ref:`API Reference: Streams <target_ap_bf_streams>`

doc/rtd/content/99_appendices/appendix1/sub/mlpro_bf/layer3_application_support/streams/howto.bf.streams.002.rst

@@ -25,5 +25,4 @@ Howto BF-STREAMS-002: Accessing Data From CSV Files
 
 
 **Cross Reference**
-
     - :ref:`API Reference: Data from CSV files <api_streams_csv_files>`

doc/rtd/content/99_appendices/appendix1/sub/mlpro_bf/layer3_application_support/streams/howto.bf.streams.003.rst

@@ -1,22 +1,22 @@
 .. _Howto_BF_STREAMS_003:
-Howto BF-STREAMS-003: Visualizing Moving 2D Clouds Provided By MLPro
-================================================
+Howto BF-STREAMS-003: Visualizing 10-dimensional Random Stream Provided By MLPro
+================================================================================
 
 **Executable code**
 
-.. literalinclude:: ../../../../../../../../../test/howtos/bf/howto_bf_streams_003_visualize_moving_clouds2d.py
+.. literalinclude:: ../../../../../../../../../test/howtos/bf/howto_bf_streams_003_native_stream_Rnd10Dx1000.py
 	:language: python
 
 
 
 **Results**
 
 .. image::
-    images/streams_moving_clouds_2d.gif
+    images/howto_bf_streams_003_native_stream_Rnd10Dx1000.gif
     :width: 600px
 
 
 
 **Cross Reference**
-
-    - :ref:`API Reference: Streams <target_ap_bf_streams>`
+   - :ref:`API Reference: 10D Random Stream <target_api_streams_rnd10d>`
+   - :ref:`API Reference: Streams <target_ap_bf_streams>`

doc/rtd/content/99_appendices/appendix1/sub/mlpro_bf/layer3_application_support/streams/howto.bf.streams.004.rst

@@ -1,21 +1,21 @@
 .. _Howto_BF_STREAMS_004:
-Howto BF-STREAMS-004: Visualizing Moving 3D Clouds Provided By MLPro
-====================================================================
+Howto BF-STREAMS-004: Visualizing 2D Double Spiral Stream Provided By MLPro
+===========================================================================
 
 **Executable code**
 
-.. literalinclude:: ../../../../../../../../../test/howtos/bf/howto_bf_streams_004_visualize_moving_clouds3d.py
+.. literalinclude:: ../../../../../../../../../test/howtos/bf/howto_bf_streams_004_native_stream_DoubleSpiral2D.py
 	:language: python
 
 
 **Results**
 
 .. image::
-    images/streams_moving_clouds_3d.gif
+    images/howto_bf_streams_004_native_stream_DoubleSpiral2D.gif
     :width: 600px
 
 
 
 **Cross Reference**
-
+    - :ref:`API Reference: Double Spiral Stream <target_api_streams_doublespiral>`
     - :ref:`API Reference: Streams <target_ap_bf_streams>`

doc/rtd/content/99_appendices/appendix1/sub/mlpro_bf/layer3_application_support/streams/howto.bf.streams.005.rst

@@ -1,58 +1,20 @@
 .. _Howto_BF_STREAMS_005:
-Howto BF-STREAMS-005: Streams Sampler
-=====================================
+Howto BF-STREAMS-005: Visualizing Multivariate Point Outlier Stream Provided By MLPro
+=====================================================================================
 
 **Executable code**
 
-
-.. literalinclude:: ../../../../../../../../../test/howtos/bf/howto_bf_streams_005_sampler.py
+.. literalinclude:: ../../../../../../../../../test/howtos/bf/howto_bf_streams_005_native_stream_PointOutliersND.py
 	:language: python
 
 
-
 **Results**
 
-.. code-block:: bashh
-
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream "": Instantiated 
-
-    Press ENTER to iterate all streams dark...
-
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream CSV File "data_storage.csv": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream CSV File "data_storage.csv": Features: 3 , Labels: 1 , Instances: 100000 
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream CSV File "data_storage.csv": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream CSV File "data_storage.csv": Number of instances being sampled: 15298 
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream CSV File "data_storage.csv": Done in 0.658  seconds (throughput = 152048 instances/sec)
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream CSV File "data_storage.csv": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream CSV File "data_storage.csv": Number of instances being sampled: 24884 
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream CSV File "data_storage.csv": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream CSV File "data_storage.csv": Number of instances being sampled: 100 
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream CSV File "data_storage.csv": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream CSV File "data_storage.csv": Number of instances being sampled: 786 
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream CSV File "data_storage.csv": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream CSV File "data_storage.csv": Number of instances being sampled: 5000
-
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream "Random 10D x 1000": Instantiated 
-
-    Press ENTER to iterate all streams dark...
-
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream "Random 10D x 1000": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream "Random 10D x 1000": Features: 10 , Labels: 2 , Instances: 1000
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream "Random 10D x 1000": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream "Random 10D x 1000": Number of instances being sampled: 150
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream "Random 10D x 1000": Done in 0.008  seconds (throughput = 133174 instances/sec)
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream "Random 10D x 1000": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream "Random 10D x 1000": Number of instances being sampled: 239
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream "Random 10D x 1000": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream "Random 10D x 1000": Number of instances being sampled: 100 
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream "Random 10D x 1000": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream "Random 10D x 1000": Number of instances being sampled: 333
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  I  Stream "Random 10D x 1000": Reset
-    YYYY-MM-DD  HH:MM:SS.SSSSSS  W  Stream "Random 10D x 1000": Number of instances being sampled: 50
-
+.. image::
+    images/howto_bf_streams_005_native_stream_PointOutliersND.gif
+    :width: 600px
 
 
 **Cross Reference**
-
-    - :ref:`API Reference: Random Samplers <ap2_samplers>`
-    - :ref:`API Reference: Data from CSV files <ap2_csv_files>`
+    - :ref:`API Reference: Multivariate Point Outlier Stream <target_api_streams_point_outliers>`
+    - :ref:`API Reference: Streams <target_ap_bf_streams>`

doc/rtd/content/99_appendices/appendix1/sub/mlpro_bf/layer3_application_support/streams/howto.bf.streams.006.rst

@@ -0,0 +1,20 @@
+.. _Howto_BF_STREAMS_006:
+Howto BF-STREAMS-006: Visualizing Static 2D Random Point Clouds Provided By MLPro
+=================================================================================
+
+**Executable code**
+
+.. literalinclude:: ../../../../../../../../../test/howtos/bf/howto_bf_streams_006_native_stream_Clouds2D4C1000Static.py
+	:language: python
+
+
+**Results**
+
+.. image::
+    images/howto_bf_streams_006_native_stream_Clouds2D4C1000Static.gif
+    :width: 600px
+
+
+**Cross Reference**
+    - :ref:`API Reference: Random Point Clouds <target_api_streams_clouds>`
+    - :ref:`API Reference: Streams <target_ap_bf_streams>`

doc/rtd/content/99_appendices/appendix1/sub/mlpro_bf/layer3_application_support/streams/howto.bf.streams.007.rst

@@ -0,0 +1,20 @@
+.. _Howto_BF_STREAMS_007:
+Howto BF-STREAMS-007: Visualizing Dynamic 2D Random Point Clouds Provided By MLPro
+==================================================================================
+
+**Executable code**
+
+.. literalinclude:: ../../../../../../../../../test/howtos/bf/howto_bf_streams_007_native_stream_Clouds2D4C5000Dynamic.py
+	:language: python
+
+
+**Results**
+
+.. image::
+    images/howto_bf_streams_007_native_stream_Clouds2D4C5000Dynamic.gif
+    :width: 600px
+
+
+**Cross Reference**
+    - :ref:`API Reference: Random Point Clouds <target_api_streams_clouds>`
+    - :ref:`API Reference: Streams <target_ap_bf_streams>`

doc/rtd/content/99_appendices/appendix1/sub/mlpro_bf/layer3_application_support/streams/howto.bf.streams.008.rst

@@ -0,0 +1,20 @@
+.. _Howto_BF_STREAMS_008:
+Howto BF-STREAMS-008: Visualizing Static 3D Random Point Clouds Provided By MLPro
+=================================================================================
+
+**Executable code**
+
+.. literalinclude:: ../../../../../../../../../test/howtos/bf/howto_bf_streams_008_native_stream_Clouds3D8C2000Static.py
+	:language: python
+
+
+**Results**
+
+.. image::
+    images/howto_bf_streams_008_native_stream_Clouds3D8C2000Static.gif
+    :width: 800px
+
+
+**Cross Reference**
+    - :ref:`API Reference: Random Point Clouds <target_api_streams_clouds>`
+    - :ref:`API Reference: Streams <target_ap_bf_streams>`

doc/rtd/content/99_appendices/appendix1/sub/mlpro_bf/layer3_application_support/streams/howto.bf.streams.009.rst

@@ -0,0 +1,20 @@
+.. _Howto_BF_STREAMS_009:
+Howto BF-STREAMS-009: Visualizing Dynamic 3D Random Point Clouds Provided By MLPro
+==================================================================================
+
+**Executable code**
+
+.. literalinclude:: ../../../../../../../../../test/howtos/bf/howto_bf_streams_009_native_stream_Clouds3D8C10000Dynamic.py
+	:language: python
+
+
+**Results**
+
+.. image::
+    images/howto_bf_streams_009_native_stream_Clouds3D8C10000Dynamic.gif
+    :width: 800px
+
+
+**Cross Reference**
+    - :ref:`API Reference: Random Point Clouds <target_api_streams_clouds>`
+    - :ref:`API Reference: Streams <target_ap_bf_streams>`