Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to clarify formats supported by audio decoder operator #5803

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion dali/operators/decoder/audio/audio_decoder_op.cc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ DALI_REGISTER_OPERATOR(decoders__Audio, AudioDecoderCpu, CPU);
DALI_SCHEMA(decoders__Audio)
.DocStr(R"code(Decodes waveforms from encoded audio data.

It supports the following audio formats: wav, flac and ogg.
It supports the following audio formats: WAV, FLAC, and OGG (including both OGG Vorbis and OGG Opus).

This operator produces the following outputs:

* output[0]: A batch of decoded data
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/audio_processing/audio_decoder.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# Audio Decoder in DALI\n",
"\n",
"This tutorial presents, how to set up a simple pipeline, that loads and decodes audio data using DALI. We will use a simple example from Speech Commands Data Set. While this dataset consists of samples in .wav format, the following procedure can be used for most of the well-known digital audio coding formats as well.\n",
"This tutorial presents, how to set up a simple pipeline, that loads and decodes audio data using DALI. We will use a simple example from Speech Commands Data Set. While this dataset consists of samples in .wav format, the following procedure can be used for most well-known digital audio coding formats, including WAV, FLAC, and OGG (both OGG Vorbis and OGG Opus)..\n",
"\n",
"## Step-by-Step Guide\n",
"1. Let's start by importing DALI and a handful of utils."
Expand Down
Loading