turicreate.SArray.summary

SArray.summary(background=False, sub_sketch_keys=None)

Summary statistics that can be calculated with one pass over the SArray.

Returns a turicreate.Sketch object which can be further queried for many descriptive statistics over this SArray. Many of the statistics are approximate. See the Sketch documentation for more detail.

Parameters:

background : boolean, optional

If True, the sketch construction will return immediately and the sketch will be constructed in the background. While this is going on, the sketch can be queried incrementally, but at a performance penalty. Defaults to False.

sub_sketch_keys : int | str | list of int | list of str, optional

For SArray of dict type, also constructs sketches for a given set of keys, For SArray of array type, also constructs sketches for the given indexes. The sub sketches may be queried using: element_sub_sketch(). Defaults to None in which case no subsketches will be constructed.

Returns:

out : Sketch

Sketch object that contains descriptive statistics for this SArray. Many of the statistics are approximate.