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

Documentation: setup-guide.md missing steps/information #451

Open
h3ndrik opened this issue Dec 28, 2023 · 2 comments
Open

Documentation: setup-guide.md missing steps/information #451

h3ndrik opened this issue Dec 28, 2023 · 2 comments
Assignees
Labels
scope/docs status/progress issues that are in progress and have a branch type/bug broken features
Milestone

Comments

@h3ndrik
Copy link

h3ndrik commented Dec 28, 2023

There are two omissions when following the procedure outlined in docs/setup-guide.md

  1. "Test the models": At this point there is no model downloaded and the script fails. It would be nice to add a wget/curl command with the URL to download the specific model that is used by scripts/test-diffusers.py
  2. After "Download the web UI bundle": The instructions abruptly stop at that point. (And are followed by some windows specifics.) Usually guides follow through until the software is running. Perhaps we could add the command that downloads and converts all the models and the command that starts Flask. At least some info on where in the documentation to continue.

And while copying the index.html etc it's not too clear that you need to use the 'api/gui' directory and not the other gui directory.

@ssube ssube self-assigned this Dec 31, 2023
@ssube ssube added type/bug broken features scope/docs labels Dec 31, 2023
@ssube ssube added this to the v0.12 milestone Dec 31, 2023
@ssube
Copy link
Owner

ssube commented Dec 31, 2023

  1. You are correct, that is a little bit out of order now. You definitely need at least one model to test, and I recently added some pre-converted ones for the Windows bundle (to save time), so I can reuse those and possibly even have the test-diffusers.py script check for the model.
  2. I can add a few more steps, that should not be a problem. At the very least I will go through the launch scripts and then end with a link to the full user guide for adding more models.
  3. The launch scripts will check for the web UI files now, and the powershell launch script will even attempt to download them, but I can make that more clear in the docs as well.

@ssube ssube added the status/planned issues that have been planned but not started label Dec 31, 2023
@ssube ssube added status/progress issues that are in progress and have a branch and removed status/planned issues that have been planned but not started labels Dec 31, 2023
@h3ndrik
Copy link
Author

h3ndrik commented Jan 2, 2024

Oh thanks, that makes it straightforward. You even mentioned the api url and everything. Thank you very much. I think a user like me is now set to follow the procedure without looking up additional information. I think we can close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope/docs status/progress issues that are in progress and have a branch type/bug broken features
Projects
None yet
Development

No branches or pull requests

2 participants