Skip to content

Starting MetalDiffusion

soten355 edited this page Aug 9, 2023 · 1 revision

Starting MetalDiffusion

Currently, MetalDiffusion can only be launched from the terminal. Remember to use the virtual environment created during the installation steps for building from source

Terminal Usage

The following section is for using MetalDiffusion via Mac's Terminal app.

Launching/Starting the program Basics

This program is run through the dream.py script, which is a Gradio Web User Interface. With Terminal run this command:

python dream.py

The web UI will automatically load into your default browser.

When you and your computer are finished creating, return to terminal and press Control C to end the Gradio web server. Alternatively, you can also quit Terminal entirely.

Launching/Starting with Overrides

By default, the Gradio WebUI will:

  • Not create a public link
  • Launch the webUI automatically in your default browser

The Gradio defaults can be overridden with command lines. For example:

python dream.py --share

This will launch the webUI and will create a public link through Gradio. This is useful for Google Colab notebooks.

Exiting Program

Via Gradio GUI

At the bottom of the page, there will be a button that says "Close Program". Clicking it will end the program. However, the Gradio webpage will still be up via your brower cache, but unable to do anything.

Via Terminal

To finish the program, in Terminal type CTRL+C and the program will quit or quit Terminal entirely. The Gradio webpage will still be up via your browser cache, but unable to do anything.