Skip to content

Getting Started

Get started with Document-to-Podcast using one of the options below:

Setup options

The easiest way to play with the code on a GPU, for free.

Click the button below to launch the project directly in Google Colab:

Click the button below to launch the project directly in GitHub Codespaces:

Once the Codespaces environment launches, inside the terminal, start the Streamlit demo by running:

python -m streamlit run demo/app.py

You can install the project from Pypi:

pip install document-to-podcast

Check the Command Line Interface guide.

Alternatively, you can clone and install it in editable mode:

  1. Clone the Repository

    git clone https://github.com/mozilla-ai/document-to-podcast.git
cd document-to-podcast

  2. Install the project and its Dependencies

    pip install -e .

  3. Run the Demo

    python -m streamlit run demo/app.py

Troubleshooting

When starting up the codespace, I get the message Oh no, it looks like you are offline!

If you are on Firefox and have Enhanced Tracking Protection On, try turning it Off for the codespace webpage.

During the installation of the package, it fails with ERROR: Failed building wheel for llama-cpp-python

You are probably missing the GNU Make package. A quick way to solve it is run on your terminal sudo apt install build-essential

When running the Streamlit demo app I get: RuntimeError: Tried to instantiate class '__path__._path', but it does not exist! Ensure that it is registered via torch::class_

This seems to be an issue with Streamlit, as of Feb 2025. If the app works fine, you can ignore it for now.