Skip to content

Commit 8b60d14

Browse files
committed
docs(demo): nest evidence scorer in demo profiles
Show type evidence wrapping a heuristic base with the RFC example factors, matching the ranking YAML the stack now wires.
1 parent 76309b6 commit 8b60d14

4 files changed

Lines changed: 18 additions & 6 deletions

File tree

doc/howto/QUICKSTART.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,17 +74,20 @@ Every change writes all of its files into one folder under `demo/`, and `FOLDERS
7474

7575
Set it deliberately when you want a run to show one thing. `FOLDERS=1` puts every change in the same place, so the queue serializes the lot and each change speculates on the one before it. A number well above `COUNT` keeps them all apart, so they go out together.
7676

77-
How much speculation that turns into is capped by the queue's **build budget** — how many builds it may have occupying CI at once, counted across every in-flight batch rather than per batch. It defaults to 4 and is set per queue in the provider's `profiles.yaml`. The demo also sets **predictor factors** there so speculation ranking revises the scorer's price when a path passes or fails or a batch is merging or cancelling; omitting that block leaves every factor at `1`, which is a no-op and ranks on the scorer alone.
77+
How much speculation that turns into is capped by the queue's **build budget** — how many builds it may have occupying CI at once, counted across every in-flight batch rather than per batch. It defaults to 4 and is set per queue in the provider's `profiles.yaml`. The demo also sets **evidence scorer factors** there so speculation ranking revises the base price when a path passes or fails or a batch is merging or cancelling; omitting `factors` leaves every factor at `1`, which is a no-op and ranks on the nested base alone.
7878

7979
```yaml
8080
defaults:
8181
speculator: {buildBudget: 4}
82-
predictor:
82+
scorer:
83+
type: evidence
8384
factors:
8485
pathPassed: 10
8586
pathFailed: 0.3
8687
merging: 12
8788
cancelling: 0.1
89+
base:
90+
type: heuristic
8891

8992
queues:
9093
- name: demo-queue

service/submitqueue/demo/provider/fake/profiles.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,17 @@ defaults:
2323
# of the outcomes it is waiting on. Four is the built-in default.
2424
speculator: {buildBudget: 4}
2525
# Example evidence factors from the outcome-predictor RFC. Omitted keys would
26-
# stay at 1 and ranking would stay on the scorer alone; writing them out makes
26+
# stay at 1 and ranking would stay on the base price; writing them out makes
2727
# the demo show how path results and batch state revise that price.
28-
predictor:
28+
scorer:
29+
type: evidence
2930
factors:
3031
pathPassed: 10
3132
pathFailed: 0.3
3233
merging: 12
3334
cancelling: 0.1
35+
base:
36+
type: heuristic
3437

3538
queues:
3639
# The queue `make demo-requests` and `make land` use by default.

service/submitqueue/demo/provider/git/profiles.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,15 @@ defaults:
1414
analyzer: {type: all}
1515
# Same example factors as ../fake/profiles.yaml — see that file for why they
1616
# are written out rather than left at the neutral default of 1.
17-
predictor:
17+
scorer:
18+
type: evidence
1819
factors:
1920
pathPassed: 10
2021
pathFailed: 0.3
2122
merging: 12
2223
cancelling: 0.1
24+
base:
25+
type: heuristic
2326

2427
queues:
2528
# The queue `make demo-requests` and `make land` use by default. Serializes

service/submitqueue/demo/provider/github/profiles.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,15 @@ defaults:
1212
analyzer: {type: all}
1313
# Same example factors as ../fake/profiles.yaml — see that file for why they
1414
# are written out rather than left at the neutral default of 1.
15-
predictor:
15+
scorer:
16+
type: evidence
1617
factors:
1718
pathPassed: 10
1819
pathFailed: 0.3
1920
merging: 12
2021
cancelling: 0.1
22+
base:
23+
type: heuristic
2124

2225
queues:
2326
- name: demo-queue

0 commit comments

Comments
 (0)