Skip to content

Commit

Permalink
DOC: Revise doc/formats/index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NickleDave committed Jun 17, 2022
1 parent 6342128 commit 653bc19
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions doc/formats/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@

# Formats

(formats-seq-like)=
This page documents the annotation formats built in to `crowsetta`.
The purpose of this section is to provide more information about
the formats themselves, including links, citations,
and schema where possible.
At the bottom of the page for each format there is a link
to the class that can load annotations in that format,
as documented in the
{ref}`formats section of the API documentation <api-formats>`.

(formats-seq-like)=
## Sequence-like

These formats can all be represented as a sequence of segments,
Expand All @@ -12,7 +20,7 @@ that assigns it to a specific class.

### widely-used

These are sequence-like formats for widely-used applications
These are sequence-like formats for widely-used applications:

- {ref}`Praat .TextGrid files <textgrid>`
- {ref}`Audacity label tracks <aud-txt>`
Expand All @@ -29,19 +37,20 @@ annotation formats.

These are formats for specific tools or datasets.
Many of them can be represented by `simple-seq` or `generic-seq`
but are provided a separate format for convenience.
but are provided as a separate format for convenience.

- {ref}`birdsong-recognition-dataset`
- {ref}`notmat`
- {ref}`timit`

(formats-bbox-like)=

## Bounding Box-like

These formats can all be represented as a set of bounding boxes,
where each box has four coordinates representing its corners,
as well as a label that assigns it to a specific class.
These formats can all be represented as a set of bounding boxes
on a spectrogram,
where each box is defined by start and stop time
as well as a low and high frequency range,
and a label that assigns the box to a specific class.

### dataset- or tool-specific

Expand Down

0 comments on commit 653bc19

Please sign in to comment.