Skip to content

Commit

Permalink
DOC: mention explicitly text files as media files
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw committed Jun 24, 2024
1 parent 25e92b2 commit 4ece8d1
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ audformat
Specification and reference implementation of **audformat**.

audformat stores media data,
such as audio or video,
such as audio, video, or text
together with corresponding annotations
in a pre-defined way.
This makes it easy to combine or replace databases
Expand Down
8 changes: 6 additions & 2 deletions docs/data-format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,13 @@ On hard disk all of them are stored inside a single folder.
The header is stored as a YAML file,
the tables contain labels stored in (possibly) multiple CSV or PARQUET files,
and the media files are usually stored in sub-folders.
Media files are not restricted to a particular file type,
but consist usually of audio, video, or text files.
Each table column is linked to a scheme and/or to a rater.
Each table row is linked to a media file,
or a specific segment in a media file.
or,
if applicable,
a specific segment in a media file.
If no links to media files are given,
the table is called miscellaneous table,
or short **misc table**.
Expand All @@ -26,7 +30,7 @@ The database is implemented as :class:`audformat.Database`.
and columns holding annotations
``db.<misc_table_id>.[csv|parquet]`` Misc table with unspecified index
and columns holding annotations
``<folder(s)/file(s)>`` Audio/Video files referenced in the tables
``<folder(s)/file(s)>`` Media files referenced in the tables
==================================== ==========================================

The connection between the header, media files and a table
Expand Down
2 changes: 1 addition & 1 deletion docs/data-introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ but simple enough to be understood and parsed easily**.

The format further allows to

* link audio files to meta data and annotations
* link media files to meta data and annotations
* use generic tools to access the data,
create statistics,
merge annotations
Expand Down

0 comments on commit 4ece8d1

Please sign in to comment.