API Reference Manual#

The API reference manual is generated directly from documentation and declarations in the source code, and is thus often much more verbose than necessary. Still, it often helps to navigate the code when necessary. Use only when you need a deep-dive into the code.


Module Structure#

WaloViz subpackages#

These subpackages should not be used directly, they contain a LOT of internal logic which is not relevant for the average user.

waloviz

The parent waloviz module itself.

_user_functions

As the name suggests - all of the top-level functionality which is officially available to the user is here.

_tensor_utils

Utilities for manipulating tensors, mostly to do with different tensor input formats support.

_holoviews_manipulations

Functions to do with holoviews , they create the elements of the plots.

_bokeh_manipulation

Functions to do with bokeh , they customize the plots interactivity and appearance.

_panel_manipulation

Functions to do with panel , they add the audio and link it to the plot.