Skip to content

Commit

Permalink
Mod: Update installation doc page.
Browse files Browse the repository at this point in the history
  • Loading branch information
Labbeti committed Aug 10, 2023
1 parent dd54333 commit d7ea6e5
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,16 @@ The python requirements are automatically installed when using pip on this repos
External requirements (AudioCaps only)
######################################

The external requirements needed to download **AudioCaps** are **ffmpeg** and **youtube-dl** or **ytdlp**.
The external requirements needed to download **AudioCaps** are **ffmpeg** and **youtube-dl** (yt-dlp should work too).
These two programs can be download on Ubuntu using `sudo apt install ffmpeg youtube-dl`.

You can also override their paths for AudioCaps:

.. code-block:: python
from aac_datasets import AudioCaps
AudioCaps.FFMPEG_PATH = "/my/path/to/ffmpeg"
AudioCaps.YOUTUBE_DL_PATH = "/my/path/to/youtube_dl_or_ytdlp"
dataset = AudioCaps(root=".", download=True)
dataset = AudioCaps(
download=True,
ffmpeg_path="/my/path/to/ffmpeg",
ytdl_path="/my/path/to/youtube_dl",
)

0 comments on commit d7ea6e5

Please sign in to comment.