Skip to content

Commit

Permalink
Update docs/usage.rst
Browse files Browse the repository at this point in the history
Co-authored-by: Hagen Wierstorf <[email protected]>
  • Loading branch information
maxschmitt and hagenw authored May 15, 2024
1 parent 607888d commit b6aa70c
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -391,15 +391,21 @@ would be a voice activity detection algorithm.
idx = interface.process_file(files[0])
idx

Sometimes, it is required that a table (i.e., `pd.Series`
or `pd.DataFrame`) is segmented and the ``labels`` from
the original segments should be kept. For this,
Sometimes,
it is required that a table
(i.e., :class:`pandas.Series` or :class`pandas.DataFrame`)
is segmented
and the ``labels`` from the original segments
should be kept.
For this,
:class:`audinterface.Segment` has a dedicated method
``process_table()``. This method is useful, if a
segmentation (e.g., voice activity detection) is
performed on an already labelled dataset in order
to do data augmentation or teacher-student training,
improving model performance for shorter chunks.
:meth:`process_table() <audinterface.Segment.process_table>`.
This method is useful,
if a segmentation
(e.g., voice activity detection)
is performed on an already labelled dataset
in order to do data augmentation
or teacher-student training.

.. jupyter-execute::

Expand Down

0 comments on commit b6aa70c

Please sign in to comment.