Skip to content

Commit

Permalink
DOC: Fix 'aud-txt' -> 'aud-seq' in several docs pages
Browse files Browse the repository at this point in the history
  • Loading branch information
NickleDave committed Mar 20, 2023
1 parent 53ddddd commit 413ea13
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion doc/formats/index.md
Expand Up @@ -23,7 +23,7 @@ that assigns it to a specific class.
These are sequence-like formats for widely-used applications:

- {ref}`Praat .TextGrid files <textgrid>`
- {ref}`Audacity label tracks <aud-txt>`
- {ref}`Audacity label tracks <aud-seq>`

### general

Expand Down
2 changes: 1 addition & 1 deletion doc/howto/convert-generic-seq.md
Expand Up @@ -91,7 +91,7 @@ we use a loop to load each one and convert it to a
We use the same dataset we used in the {ref}`tutorial` for this example,
["Labeled songs of domestic canary M1-2016-spring (Serinus canaria)"](https://zenodo.org/record/6521932)
by Giraudon et al., 2021,
annotated with {ref}`Audacity Labeltrack <aud-txt>` files.
annotated with {ref}`Audacity Labeltrack <aud-seq>` files.

```{code-cell} ipython3
cd ..
Expand Down
6 changes: 3 additions & 3 deletions doc/index.md
Expand Up @@ -45,7 +45,7 @@ Such annotations typically include the times when sound events start and stop,
and labels that assign each sound to some set of classes
chosen by the annotator.
crowsetta has built-in support for many widely used {ref}`formats <formats-index>`
such as {ref}`Audacity label tracks <aud-txt>`,
such as {ref}`Audacity label tracks <aud-seq>`,
{ref}`Praat .TextGrid files <textgrid>`,
and {ref}`Raven .txt files <raven>`.
The images below show examples of the two families of annotation formats
Expand Down Expand Up @@ -137,7 +137,7 @@ With crowsetta, you can:
* work with your annotations in Python,
taking advantage of built-in support
for many widely used {ref}`formats <formats-index>`
such as {ref}`Audacity label tracks <aud-txt>`,
such as {ref}`Audacity label tracks <aud-seq>`,
{ref}`Praat .TextGrid files <textgrid>`,
and {ref}`Raven .txt files <raven>`.
* work with any format by remembering just one class:
Expand All @@ -156,7 +156,7 @@ With crowsetta, you can:
<h3>Built-in support for many widely-used formats</h3>

crowsetta has built-in support for many widely used {ref}`formats <formats-index>`
such as {ref}`Audacity label tracks <aud-txt>`,
such as {ref}`Audacity label tracks <aud-seq>`,
{ref}`Praat .TextGrid files <textgrid>`,
and {ref}`Raven .txt files <raven>`.

Expand Down
10 changes: 5 additions & 5 deletions doc/tutorial.md
Expand Up @@ -42,7 +42,7 @@ vocalizations, we need some audio files containing vocalizations that
are annotated.

We download some examples of annotation files in the
{ref}`Audacity LabelTrack format <aud-txt>`,
{ref}`Audacity LabelTrack format <aud-seq>`,
from the dataset
["Labeled songs of domestic canary M1-2016-spring (Serinus canaria)"](https://zenodo.org/record/6521932)
by Giraudon et al., 2021.
Expand Down Expand Up @@ -83,7 +83,7 @@ means, but you do have to know that before you can do anything with a
and assign it to some variable, like this:

```{code-cell} ipython3
scribe = crowsetta.Transcriber(format='aud-txt')
scribe = crowsetta.Transcriber(format='aud-seq')
print("scribe is an instance of a", type(scribe))
```

Expand Down Expand Up @@ -128,7 +128,7 @@ or bounding box-lie,
the `Annotation` will either have a `seq` attribute,
short for "Sequence", or a `bbox` attribute,
short for "Bounding box".
Since `'aud-txt'` is a sequence-like format,
Since `'aud-seq'` is a sequence-like format,
the `Annotation`s have a `seq` attribute:

```{code-cell} ipython3
Expand Down Expand Up @@ -175,12 +175,12 @@ what we really want is some data types
that make it easier to work with our annotations,
and that help us write clean, readable code.

The {ref}`Audacity .txt <aud-txt>` format
The {ref}`Audacity .txt <aud-seq>` format
we are using in this tutorial above is one of what
crowsetta calls a "sequence-like" format,
as stated above.
What this means is that we can convert our
each one of our `'aud-txt'` annotations to
each one of our `'aud-seq'` annotations to
a `Sequence`.
Each `Sequence` consists of some number of `Segment`s, i.e., a
part of the sequence defined by an `onset` and `offset` that has a
Expand Down

0 comments on commit 413ea13

Please sign in to comment.