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

docs: Fix missing setup instructions #377

Merged
merged 7 commits into from
Dec 21, 2024
Merged
Show file tree
Hide file tree
Changes from 5 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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ If you are willing to try with your AMD card, join the [discord discussion](http

1. Make a copy of `bridgeData_template.yaml` to `bridgeData.yaml`
2. Edit `bridgeData.yaml` and follow the instructions within to fill in your details.
3. Change `dreamer_name`.
- This name must be unique horde wide. If you get an error about "Wrong Credentials", someone else already reserved this name.

#### Suggested settings

Expand Down
16 changes: 15 additions & 1 deletion bridgeData_template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ require_upfront_kudos: false
#######################################

# Worker name for running a Dreamer instance.
# This must be unique across the entire horde! Do not use the default!
# If you get the error `Wrong credentials to submit as this worker.`, try changing this name, someone else is already using it.
dreamer_name: "An Awesome Dreamer"

# Max resolution (max pixels) supported.
Expand Down Expand Up @@ -283,7 +285,12 @@ exit_on_unhandled_faults: false
## Scribe (LLM Worker) ##
#########################

# Note: Scribe is not currently supported in reGen. This section is for future use.
# Use https://github.com/Haidra-Org/AI-Horde-Worker to run a Scribe worker.

# Worker name for running a Scribe worker.
# This must be unique across the entire horde! Do not use the default!
# If you get the error `Wrong credentials to submit as this worker.`, try changing this name, someone else is already using it.
scribe_name: "An Awesome Scribe"

# KoboldAI Client API URL.
Expand All @@ -299,9 +306,16 @@ max_context_length: 1024
# Prevents the model from being used from the shared pool but ensures no other worker can pretend to serve it.
branded_model: true

## Alchemist (Image Interrogation and Post-Processing)
#########################
## Alchemist (Image Interrogation and Post-Processing)
#########################

# Note: Scribe is not currently supported in reGen. This section is for future use.
# Use https://github.com/Haidra-Org/AI-Horde-Worker to run an Alchemist worker.

# Worker name for running an Alchemist worker.
# This must be unique across the entire horde! Do not use the default!
# If you get the error `Wrong credentials to submit as this worker.`, try changing this name, someone else is already using it.
alchemist_name: "An Awesome Alchemist"

# Alchemy forms this worker can serve.
Expand Down
6 changes: 5 additions & 1 deletion horde_worker_regen/process_management/process_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -3504,7 +3504,11 @@ async def api_job_pop(self) -> None:
)
elif "wrong credentials" in job_pop_response.message.lower():
logger.warning(f"Failed to pop job (Wrong Credentials): {job_pop_response}")
logger.error("Did you forget to set your worker name?")
logger.error("Did you forget to set your worker name (`dreamer_name` in bridgeData.yaml)?")
logger.error(
"Horde Worker names must be unique horde-wide. If you haven't used this name before, "
"try changing your worker name.",
)
else:
logger.error(f"Failed to pop job (API Error): {job_pop_response}")
self._job_pop_frequency = self._error_job_pop_frequency
Expand Down
Loading