Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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
12 changes: 12 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
The examples in this directory demonstrate applied use of the torchaudio library. They are included only for reference purposes.

> [!NOTE]
> **We have transitioned TorchAudio into a
> maintenance phase. Our main goals were to reduce redundancies with the rest of the
> PyTorch ecosystem, make it easier to maintain, and create a version of
> TorchAudio that is more tightly scoped to its strengths: processing audio
> data for ML. Because of this transition, the examples included here will no longer be maintained
> going forward. The scripts may not work properly as is. For hands on examples of features in the
> library that *are* still supported, see the "tutorials" subdirectory. Please see
> [our community message](https://github.com/pytorch/audio/issues/3902)
> for more details.**
3 changes: 0 additions & 3 deletions examples/libtorchaudio/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@ cmake_minimum_required(VERSION 3.5)

project(libtorchaudio-cpp-example)

SET(BUILD_SOX ON CACHE BOOL "Build libsox into libtorchaudio")

SET(BUILD_KALDI OFF CACHE BOOL "Build Kaldi into libtorchaudio")
SET(BUILD_RNNT ON CACHE BOOL "Build RNN transducer into libtorchaudio")
SET(BUILD_TORCHAUDIO_PYTHON_EXTENSION OFF CACHE BOOL "Build Python binding")

Expand Down
1 change: 0 additions & 1 deletion examples/libtorchaudio/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Libtorchaudio Examples

* [Augmentation](./augmentation)
* [Speech Recognition with wav2vec2.0](./speech_recognition)

## Build
Expand Down
6 changes: 1 addition & 5 deletions examples/libtorchaudio/speech_recognition/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Speech Recognition with wav2vec2.0

This example demonstarates how you can use torchaudio's I/O features and models to run speech recognition in C++ application.

**NOTE**
This example uses `"sox_io"` backend for loading audio, which does not work on Windows. To make it work on
Windows, you need to replace the part of loading audio and converting it to Tensor object.
This example demonstarates how you can use torchaudio's models to run speech recognition in a C++ application.

## 1. Create a transcription pipeline TorchScript file

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from ._hubert_datamodule import HuBERTDataModule
from ._wav2vec2_datamodule import Wav2Vec2DataModule

__all__ = [
"HuBERTDataModule",
Expand Down