Skip to content

Commit

Permalink
fixing headings in rst docs for timeseries (#54)
Browse files Browse the repository at this point in the history
* fixing headings in rst docs for timeseries

* fixed incorrect length per PR review
  • Loading branch information
ashwin-patil committed Apr 6, 2020
1 parent 606fc8f commit 0ad166a
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions docs/source/visualization/TimeSeriesAnomalies.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
msticpy - Time Series Analysis and Anomalies Visualization
==========================================================
Time Series Analysis and Anomalies Visualization
================================================

This notebook demonstrates the time series analysis and anomalies
visualization built using the `Bokeh
Expand Down Expand Up @@ -67,15 +67,15 @@ TechCommunity blog posts
qry_prov.connect(connection_str=ws_config.code_connect_str)
Generating Time Series Data
===========================
---------------------------

Time Series is a series of data points indexed (or listed or graphed) in
time order. The data points are often discrete numeric points such as
frequency of counts or occurrences against a timestamp column of the
dataset

Using LogAnalytics Query Provider
---------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

msticpy has a QueryProvider through which you can connect to LogAnalytics
Data environment. via ``QueryProvider(data_environment="LogAnalytics")``
Expand Down Expand Up @@ -213,7 +213,7 @@ Query, data source, parameters and parameterized raw KQL query


Time Series Analysis and discovering Anomalies
==============================================
----------------------------------------------

By analyzing time series data over an extended period, we can identify
time-based patterns (e.g. seasonality, trend etc.) in the data and
Expand All @@ -227,7 +227,7 @@ from the input data and take it into consideration when flagging
anomalies.

Using Built-in KQL to generate TimeSeries decomposition
-------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In this case, we will use built-in KQL function ``series_decompose()``
to decompose time series to generate additional data points such as
Expand Down Expand Up @@ -346,7 +346,7 @@ the similar details
</div>

Read From External Sources
--------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^

If you have time series data in other locations, you can read it via
pandas or respective data store API where data is stored. The pandas I/O
Expand Down Expand Up @@ -445,7 +445,7 @@ KQL Time series functions such as ``series_decompose_anomalies()``.


Displaying Time Series anomaly alerts
-------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can also use ``series_decompose_anomalies()`` which will run Anomaly
Detection based on series decomposition. This takes an expression
Expand Down Expand Up @@ -621,18 +621,18 @@ other suspicious activity from other datasources.


Time Series Anomalies Visualization
===================================
-----------------------------------

Time series anomalies once discovered, you can visualize with line chart
type to display outliers. Below we will see 2 types to visualize using msticpy function
``display_timeseries_anomalies()`` via Bokeh library as well as using
built-in KQL ``render``.

Using Bokeh Visualization Library
---------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Documentation for display_timeseries_anomalies
----------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::

Expand Down Expand Up @@ -725,7 +725,7 @@ Documentation for display_timeseries_anomalies


Exporting Plots as PNGs
=======================
^^^^^^^^^^^^^^^^^^^^^^^

To use bokeh.io image export functions you need selenium, phantomjs and
pillow installed:
Expand Down Expand Up @@ -771,14 +771,14 @@ function.


Here is our saved plot: plot.png
--------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. image:: _static/TimeSeriesAnomaliesExport.png


Using Built-in KQL render operator
----------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Render operator instructs the user agent to render the results of the
query in a particular way. In this case, we are using timechart which
Expand Down

0 comments on commit 0ad166a

Please sign in to comment.