diff --git a/README.rst b/README.rst index 5a6e1222..2055aeb5 100644 --- a/README.rst +++ b/README.rst @@ -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 diff --git a/docs/data-format.rst b/docs/data-format.rst index f710e87d..bc5f5a57 100644 --- a/docs/data-format.rst +++ b/docs/data-format.rst @@ -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**. @@ -26,7 +30,7 @@ The database is implemented as :class:`audformat.Database`. and columns holding annotations ``db..[csv|parquet]`` Misc table with unspecified index and columns holding annotations - ```` Audio/Video files referenced in the tables + ```` Media files referenced in the tables ==================================== ========================================== The connection between the header, media files and a table diff --git a/docs/data-introduction.rst b/docs/data-introduction.rst index 6b184b8b..e4a3afe8 100644 --- a/docs/data-introduction.rst +++ b/docs/data-introduction.rst @@ -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