larray.Session.summary

Session.summary(template=None)

Returns a summary of the content of the session.

Parameters:

template: str

Template describing how items are summarized (see examples). Available arguments are ‘name’, ‘axes_names’ and ‘title’

Returns:

str

Short representation of the content of the session.

.

Examples

>>> arr1 = ndtest((2, 2), title='array 1')
>>> arr2 = ndtest(4, title='array 2')
>>> arr3 = ndtest((3, 2), title='array 3')
>>> s = Session([('arr1', arr1), ('arr2', arr2), ('arr3', arr3)])
>>> print(s.summary())  
arr1: a, b
    array 1
arr2: a
    array 2
arr3: a, b
    array 3
>>> print(s.summary("{name} -> {axes_names}"))
arr1 -> a, b
arr2 -> a
arr3 -> a, b