From 413ea13bd38324a27a0ff2d82981213658e7ae32 Mon Sep 17 00:00:00 2001 From: David Nicholson Date: Mon, 20 Mar 2023 13:19:22 -0400 Subject: [PATCH] DOC: Fix 'aud-txt' -> 'aud-seq' in several docs pages --- doc/formats/index.md | 2 +- doc/howto/convert-generic-seq.md | 2 +- doc/index.md | 6 +++--- doc/tutorial.md | 10 +++++----- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/formats/index.md b/doc/formats/index.md index d511acf..42b6d71 100644 --- a/doc/formats/index.md +++ b/doc/formats/index.md @@ -23,7 +23,7 @@ that assigns it to a specific class. These are sequence-like formats for widely-used applications: - {ref}`Praat .TextGrid files ` -- {ref}`Audacity label tracks ` +- {ref}`Audacity label tracks ` ### general diff --git a/doc/howto/convert-generic-seq.md b/doc/howto/convert-generic-seq.md index 6bb14d6..d7ecbcc 100644 --- a/doc/howto/convert-generic-seq.md +++ b/doc/howto/convert-generic-seq.md @@ -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 ` files. +annotated with {ref}`Audacity Labeltrack ` files. ```{code-cell} ipython3 cd .. diff --git a/doc/index.md b/doc/index.md index 9d51596..7ca67f3 100644 --- a/doc/index.md +++ b/doc/index.md @@ -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 ` -such as {ref}`Audacity label tracks `, +such as {ref}`Audacity label tracks `, {ref}`Praat .TextGrid files `, and {ref}`Raven .txt files `. The images below show examples of the two families of annotation formats @@ -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 ` - such as {ref}`Audacity label tracks `, + such as {ref}`Audacity label tracks `, {ref}`Praat .TextGrid files `, and {ref}`Raven .txt files `. * work with any format by remembering just one class: @@ -156,7 +156,7 @@ With crowsetta, you can:

Built-in support for many widely-used formats

crowsetta has built-in support for many widely used {ref}`formats ` -such as {ref}`Audacity label tracks `, +such as {ref}`Audacity label tracks `, {ref}`Praat .TextGrid files `, and {ref}`Raven .txt files `. diff --git a/doc/tutorial.md b/doc/tutorial.md index d3ad87f..f00a855 100644 --- a/doc/tutorial.md +++ b/doc/tutorial.md @@ -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 `, +{ref}`Audacity LabelTrack format `, from the dataset ["Labeled songs of domestic canary M1-2016-spring (Serinus canaria)"](https://zenodo.org/record/6521932) by Giraudon et al., 2021. @@ -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)) ``` @@ -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 @@ -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 ` format +The {ref}`Audacity .txt ` 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