.. _chart_gallery.tsa:
=====================================
Machine Learning - Time Series Plots
=====================================
.. Necessary Code Elements
.. ipython:: python
:suppress:
:okwarning:
import verticapy as vp
import verticapy.datasets as vpd
from verticapy.machine_learning.vertica.tsa import ARIMA
import numpy as np
data = vpd.load_airline_passengers()
# Defining the Models
model = ARIMA(order = (12, 1, 2))
# Fitting the models
model.fit(data, "date", "passengers")
General
-------
In this example, we aim to present several regression plots, including linear regression, tree-based algorithms, and various residual plots. It's important to note that these plots are purely illustrative and are based on generated data. To make the data more realistically representative, we introduce some noise, resulting in an approximately linear relationship.
Let's begin by importing ``verticapy``.
.. ipython:: python
import verticapy as vp
Let's use the airline passengers' dataset for this example.
.. ipython:: python
import verticapy.datasets as vpd
data = vpd.load_airline_passengers()
Let's proceed by creating an ARIMA model to fit the time-series data.
.. code-block:: python
# Importing the Vertica ML module
from verticapy.machine_learning.vertica.tsa import ARIMA
# Defining the Models
model = ARIMA(order = (12, 1, 2))
# Fitting the models
model.fit(data, "date", "passengers")
In the context of data visualization, we have the flexibility to harness multiple plotting libraries to craft a wide range of graphical representations. VerticaPy, as a versatile tool, provides support for several graphic libraries, such as Matplotlib, Highcharts, and Plotly. Each of these libraries offers unique features and capabilities, allowing us to choose the most suitable one for our specific data visualization needs.
.. image:: ../../docs/source/_static/plotting_libs.png
:width: 80%
:align: center
.. note::
To select the desired plotting library, we simply need to use the :py:func:`~verticapy.set_option` function. VerticaPy offers the flexibility to smoothly transition between different plotting libraries. In instances where a particular graphic is not supported by the chosen library or is not supported within the VerticaPy framework, the tool will automatically generate a warning and then switch to an alternative library where the graphic can be created.
Please click on the tabs to view the various graphics generated by the different plotting libraries.
.. ipython:: python
:suppress:
import verticapy as vp
.. tab:: Plotly
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "plotly")
We can switch to using the ``plotly`` module.
.. code-block:: python
vp.set_option("plotting_lib", "plotly")
.. code-block:: python
model.plot(data, "date", "passengers", npredictions = 20, start = 140)
.. ipython:: python
:suppress:
:okwarning:
fig = model.plot(data, "date", "passengers", npredictions = 20, start = 140)
fig.write_html("figures/plotting_plotly_tsa_1.html")
.. raw:: html
:file: /project/data/VerticaPy/docs/figures/plotting_plotly_tsa_1.html
.. tab:: Highcharts
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "highcharts")
We can switch to using the ``highcharts`` module.
.. code-block:: python
vp.set_option("plotting_lib", "highcharts")
.. code-block:: python
model.plot(data, "date", "passengers", npredictions = 20, start = 140)
.. ipython:: python
:suppress:
fig = model.plot(data, "date", "passengers", npredictions = 20, start = 140)
html_text = fig.htmlcontent.replace("container", "plotting_highcharts_tsa_1")
with open("figures/plotting_highcharts_tsa_1.html", "w") as file:
file.write(html_text)
.. raw:: html
:file: /project/data/VerticaPy/docs/figures/plotting_highcharts_tsa_1.html
.. tab:: Matplotlib
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "matplotlib")
We can switch to using the ``matplotlib`` module.
.. code-block:: python
vp.set_option("plotting_lib", "matplotlib")
.. ipython:: python
:okwarning:
@savefig plotting_matplotlib_tsa_1.png
model.plot(data, "date", "passengers", npredictions = 20, start = 140)
___________________
Chart Customization
-------------------
VerticaPy empowers users with a high degree of flexibility when it comes to tailoring the visual aspects of their plots.
This customization extends to essential elements such as **color schemes**, **text labels**, and **plot sizes**, as well as a wide range of other attributes that can be fine-tuned to align with specific design preferences and analytical requirements. Whether you want to make your visualizations more visually appealing or need to convey specific insights with precision, VerticaPy's customization options enable you to craft graphics that suit your exact needs.
.. Important:: Different customization parameters are available for Plotly, Highcharts, and Matplotlib.
For a comprehensive list of customization features, please consult the documentation of the respective
libraries: `plotly `_, `matplotlib `_ and `highcharts `_.
Colors
~~~~~~
.. tab:: Plotly
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "plotly")
**Custom colors**
.. code-block:: python
fig = model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"])
.. ipython:: python
:suppress:
:okwarning:
fig = model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"])
fig.write_html("figures/plotting_plotly_tsa_plot_custom_color_1.html")
.. raw:: html
:file: /project/data/VerticaPy/docs/figures/plotting_plotly_tsa_plot_custom_color_1.html
.. tab:: Highcharts
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "highcharts")
**Custom colors**
.. code-block:: python
model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"])
.. ipython:: python
:suppress:
fig = model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"])
html_text = fig.htmlcontent.replace("container", "plotting_highcharts_tsa_plot_custom_color_1")
with open("figures/plotting_highcharts_tsa_plot_custom_color_1.html", "w") as file:
file.write(html_text)
.. raw:: html
:file: /project/data/VerticaPy/docs/figures/plotting_highcharts_tsa_plot_custom_color_1.html
.. tab:: Matplolib
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "matplotlib")
**Custom colors**
.. ipython:: python
@savefig plotting_matplotlib_tsa_plot_custom_color_1.png
model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"])
____
Size
~~~~
.. tab:: Plotly
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "plotly")
**Custom Width and Height**
.. code-block:: python
model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"], width = 450, height = 450)
.. ipython:: python
:suppress:
:okwarning:
fig = model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"], width = 450, height = 450)
fig.write_html("figures/plotting_plotly_tsa_plot_custom_size.html")
.. raw:: html
:file: /project/data/VerticaPy/docs/figures/plotting_plotly_tsa_plot_custom_size.html
.. tab:: Highcharts
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "highcharts")
**Custom Width and Height**
.. code-block:: python
model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"], width = 500, height = 200)
.. ipython:: python
:suppress:
fig = model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"], width = 500, height = 200)
html_text = fig.htmlcontent.replace("container", "plotting_highcharts_tsa_plot_custom_size")
with open("figures/plotting_highcharts_tsa_plot_custom_size.html", "w") as file:
file.write(html_text)
.. raw:: html
:file: /project/data/VerticaPy/docs/figures/plotting_highcharts_tsa_plot_custom_size.html
.. tab:: Matplolib
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "matplotlib")
**Custom Width and Height**
.. ipython:: python
:okwarning:
@savefig plotting_matplotlib_tsa_plot_single_custom_size.png
model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"], width = 6, height = 4)
_____
Text
~~~~
.. tab:: Plotly
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "plotly")
**Custom Title**
.. code-block:: python
model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"], title_text ="Custom Title")
.. ipython:: python
:suppress:
fig = model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"], title_text ="Custom Title", width = 600)
fig.write_html("figures/plotting_plotly_tsa_plot_custom_main_title.html")
.. raw:: html
:file: /project/data/VerticaPy/docs/figures/plotting_plotly_tsa_plot_custom_main_title.html
**Custom Axis Titles**
.. code-block:: python
model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"], yaxis_title = "Custom Y-Axis Title")
.. ipython:: python
:suppress:
fig = model.plot(data, "date", "passengers", npredictions = 20, start = 140, colors = ["red", "green"], yaxis_title = "Custom Y-Axis Title", width = 600)
fig.write_html("figures/plotting_plotly_tsa_plot_custom_y_title.html")
.. raw:: html
:file: /project/data/VerticaPy/docs/figures/plotting_plotly_tsa_plot_custom_y_title.html
.. tab:: Highcharts
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "highcharts")
**Custom Title Text**
.. code-block:: python
model.plot(data, "date", "passengers", npredictions = 20, start = 140, title = {"text": "Custom Title"})
.. ipython:: python
:suppress:
fig = model.plot(data, "date", "passengers", npredictions = 20, start = 140, title = {"text": "Custom Title"})
html_text = fig.htmlcontent.replace("container", "plotting_highcharts_tsa_plot_custom_text_title")
with open("figures/plotting_highcharts_tsa_plot_custom_text_title.html", "w") as file:
file.write(html_text)
.. raw:: html
:file: /project/data/VerticaPy/docs/figures/plotting_highcharts_tsa_plot_custom_text_title.html
**Custom Axis Titles**
.. code-block:: python
model.plot(data, "date", "passengers", npredictions = 20, start = 140, xAxis = {"title": {"text": "Custom X-Axis Title"}})
.. ipython:: python
:suppress:
fig = model.plot(data, "date", "passengers", npredictions = 20, start = 140, xAxis = {"title": {"text": "Custom X-Axis Title"}})
html_text = fig.htmlcontent.replace("container", "plotting_highcharts_tsa_plot_custom_text_xtitle")
with open("figures/plotting_highcharts_tsa_plot_custom_text_xtitle.html", "w") as file:
file.write(html_text)
.. raw:: html
:file: /project/data/VerticaPy/docs/figures/plotting_highcharts_tsa_plot_custom_text_xtitle.html
.. tab:: Matplolib
.. ipython:: python
:suppress:
vp.set_option("plotting_lib", "matplotlib")
**Custom Title Text**
.. ipython:: python
:okwarning:
@savefig plotting_matplotlib_tsa_plot_custom_title_label.png
model.plot(data, "date", "passengers", npredictions = 20, start = 140).set_title("Custom Title")
**Custom Axis Titles**
.. ipython:: python
:okwarning:
@savefig plotting_matplotlib_tsa_plot_custom_yaxis_label.png
model.plot(data, "date", "passengers", npredictions = 20, start = 140).set_ylabel("Custom Y Axis")
_____