Skip to content

Commit e78f023

Browse files
committed
docs: describe Bering as general-purpose model producer
1 parent 7d100d3 commit e78f023

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Bering
22

3-
Bering is the upstream model discovery tool for Sheaft.
3+
Bering is a model discovery and contract-producing tool for resilience analysis.
44
It consumes trace artifacts and produces canonical `bering-model.json` in
5-
`BeringResilienceModel` v1.0.0 contract format.
5+
`BeringResilienceModel` v1.0.0 format for any downstream consumer.
6+
Sheaft is a reference consumer, not an exclusive target.
67

78
## Contract (strict)
89

@@ -57,7 +58,7 @@ go run ./cmd/bering validate \
5758
--input examples/outputs/bering-model.normalized.sample.json
5859
```
5960

60-
### 3) Run Sheaft manually on generated model
61+
### 3) Optional: run Sheaft on generated model (reference consumer)
6162

6263
```bash
6364
# from sibling Sheaft repository

docs/mvp-scope-and-limits.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## In scope
44

55
- Discover model from trace files/directories.
6-
- Emit Sheaft-compatible `bering-model.json` (v1.0.0 contract).
6+
- Emit canonical `bering-model.json` (v1.0.0 contract) compatible with Sheaft and other downstream analytics tools.
77
- Validate artifact with strict `metadata.schema` match.
88
- Deterministic output ordering and canonical JSON serialization.
99

@@ -28,4 +28,3 @@ Result is clamped to `[0,1]` and rounded to 2 decimals.
2828

2929
This score is informational in MVP and should not be interpreted as a calibrated
3030
probability of correctness.
31-

0 commit comments

Comments
 (0)