*************
visualization
*************

This module implements some common plotting functions to visualize the output data.
For more examples on visualizing the outputs,
please see the `tutorial <https://github.com/xinyiguan/py2lispIDyOM/blob/master/tutorials/3_visualizing_outputs.ipynb>`__.


In the current version, only limited basic plots are available.
The following types of basic plots are the ones we find helpful for analysis:

- `simple_plot`
- `selected_surprisal_entropy`
- `all_surprisal`
- `all_entropy`
- `pianoroll_pitch_prediction_groundtruth`
- `pianoroll_groundtruth_overall_surprisal`

You are welcome to contribute or make your own figs.



.. currentmodule:: py2lispIDyOM.viz

.. autoclass:: BasicPlot
   :members: