Skip to content

Commit d85b3a1

Browse files
pazkerotazlin
andauthored
Update kudos.md with information about escrow (#3)
* Update kudos.md with information about escrow As discussed in Discord: Tazlin — 23:43 > Feel free to open a PR to that effect * Remove trailing whitespace Always a reminder to avoid using the builtin web IDE... * docs: define uptime kudos and better explain escrow for new users --------- Co-authored-by: tazlin <tazlin.on.github@gmail.com>
1 parent 3116029 commit d85b3a1

2 files changed

Lines changed: 15 additions & 1 deletion

File tree

docs/definitions.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,19 @@ See also [horde-sdk](#horde-sdk) for the official Python SDK for interacting wit
2020
2121
`Kudos` is the priority system that determines which [user](#user)'s request is processed first. [Workers](#worker) earn kudos when they complete a [job](#job), and users spend kudos to make requests. Kudos can be traded but not sold. Users cannot go below a certain minimum, and they can still submit requests even when they have reached their minimum balance.
2222

23+
> For details on kudos earned for availability, see [Uptime Kudos](#uptime-kudos).
24+
2325
### Request
2426

2527
The [payload](#payload) sent by the [user](#user) via their chosen [integration](#integration). A request can be for one or more [jobs](#job). Each request receives a unique ID (UUID) for the user who requested it to track its status.
2628

29+
### Uptime Kudos
30+
31+
**Uptime Kudos** are awarded to [workers](#worker) for being online and available, regardless of whether they are actively processing jobs. Every 10 minutes, a nominal amount of kudos is granted, with the amount increasing based on the number of models (for [Dreamers](#dreamer)) or model parameters (for [Scribes](#scribe)) served. This system encourages reliability and a steady pool of available workers.
32+
33+
- **New users** have their uptime kudos held in escrow until they become [trusted](#trusted), at which point all escrowed kudos are released and full rewards are granted immediately going forward.
34+
- Uptime kudos are separate from those earned for completing jobs and help maintain a healthy, available infrastructure for all users.
35+
2736
### Job
2837

2938
Each [request](#request) is split into multiple `jobs` so that it can be better parallelized to different [workers](#worker). Each job has a unique ID (UUID) which is not the same as the request UUID. Each job is assigned only to the worker which picked it up and allows the user to track which worker fulfilled it. A worker cannot see any information about the [user](#user) who requested a specific job.
@@ -86,7 +95,7 @@ A classification for a worker or user which specifies extra restrictions.
8695

8796
### Trusted
8897

89-
A [user](#user) who has run a [worker](#worker) for at least one week and generated a significant amount of [kudos](#kudos) through inference. Trusted users get the ability to run a worker behind a VPN, and they cannot get [suspicion](#suspicious) anymore. They also get a special role in the official Discord server.
98+
A [user](#user) who has run a [worker](#worker) for at least one week and generated a significant amount of [kudos](#kudos) through inference. Trusted users receive all of their [uptime kudos](definitions.md#uptime-kudos) held in escrow (and the full amount immediately moving forward), get the ability to run a worker behind a VPN, and they cannot get [suspicion](#suspicious) anymore. They also get a special role in the official Discord server.
9099

91100
### Suspicious
92101

docs/kudos.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ This means that **kudos are the fundamental unit of exchange of resources on the
2222
- If two users have the same kudos and they were to submit a job at the same time, they can expect that both jobs would return in about the same amount of time.
2323
- **Unspent kudos are a donation to the community**
2424
- Workers who choose to not spend their kudos are effectively donating their resources to the project.
25+
- **Kudos can be earned by running [a worker](https://github.com/Haidra-Org/horde-worker-reGen) and contributing to the Horde.**
26+
- You get kudos simply by being online ([uptime kudos](definitions.md#uptime-kudos)) and available as a worker, in addition to earning kudos for successfully completed jobs.
27+
- Note: New users have their kudos earned for [uptime](definitions.md#uptime-kudos) held in escrow until they become [trusted](definitions.md#trusted), which happens automatically after a certain amount of uptime and jobs successfully submitted. At that point they receive the escrowed kudos and full rewards immediately going forward.
28+
- **You do not need a powerful GPU to earn Kudos.**
29+
- Besides gifts and image workers, you can participate in Discord Bounties, rate images, or run text generators and interrogators (for less potent GPUs) to earn Kudos.
2530

2631
## Priority System
2732

0 commit comments

Comments
 (0)