cubed.visualize

Contents

cubed.visualize#

cubed.visualize(*arrays, filename='cubed', format=None, optimize_graph=True, optimize_function=None, show_hidden=False)#

Produce a visualization of the computation graph for multiple arrays.

Parameters:
  • arrays (cubed.CoreArray) – The arrays to include in the visualization.

  • filename (str) – The name of the file to write to disk. If the provided filename doesn’t include an extension, ‘.svg’ will be used by default.

  • format ({'png', 'pdf', 'dot', 'svg', 'jpeg', 'jpg'}, optional) – Format in which to write output file. Default is ‘svg’.

  • optimize_graph (bool, optional) – If True, the graph is optimized before rendering. Otherwise, the graph is displayed as is. Default is True.

  • optimize_function (callable, optional) – Function to optimize the computation graph. Default is to use a function that performs map fusion only.

  • show_hidden (bool) – If True, show arrays and operations that are marked as hidden in the visualization. Default is False.

Returns:

An IPython SVG image if IPython can be imported (for rendering in a notebook), otherwise None.

Return type:

IPython.display.SVG, or None