TextData.describe#

TextData.describe(n_properties_to_show: Optional[int] = 4, properties_to_show: Optional[List[str]] = None, max_num_labels_to_show: Optional[int] = 5, model_classes: Optional[List[str]] = None)[source]#

Provide holistic view of the data.

Generates the following plots: 1. Label distribution 2. Statistics about the data such as number of samples, annotation ratio, list of metadata columns, list of text properties and so on. 3. Property distribution for the text properties defined either by n_properties_to_show or properties_to_show parameter.

Parameters
n_properties_to_showint, default: 4

Number of properties to consider for generating property distribution graphs. If properties_to_show is provided, this value is ignored.

properties_to_showList[str], default: None

List of property names to consider for generating property distribution graphs. If None, all the properties are considered.

max_num_labels_to_showint, default: 5

The threshold to display the maximum number of labels on the label distribution pie chart and display rest of the labels under “Others” category.

model_classesOptional[List[str]], default: None

List of classes names to use for multi-label display. Only used if the dataset is multi-label.

Returns
Displays the Plotly Figure.