vak.common.annotation.format_from_df#

vak.common.annotation.format_from_df(dataset_df: DataFrame) str[source]#

Get the format of annotations from a dataset, given a dataframe representing that dataset.

Returns string name of annotation format. If no annotation format is specified, returns None. Raises an error if there are multiple formats.

Parameters:

dataset_df (pandas.DataFrame) – Representing a dataset of vocalizations, with column ‘annot_format’.

Returns:

annot_format – format of annotations for vocalizations.

Return type:

str