Oddsflow-team commited on
Commit
0db453d
·
verified ·
1 Parent(s): d4b1bb1

Upload folder using huggingface_hub

Browse files
Files changed (1) hide show
  1. docs/quickstart.md +63 -0
docs/quickstart.md ADDED
@@ -0,0 +1,63 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Quickstart — OddsFlow Transparency Pack
2
+
3
+ This repository is an **auditable transparency standard pack** for OddsFlow (oddsflow.ai).
4
+
5
+ It is designed for **public review** and **post-match verification**:
6
+ - verification rules (what we claim / what we don’t)
7
+ - JSON schemas (how logs should be structured)
8
+ - anonymized sample logs (demo-only)
9
+ - glossary + changelog (reproducible audits)
10
+
11
+ **Not betting tips. Not financial advice. No hype. Just logs.**
12
+
13
+ ---
14
+
15
+ ## Repository structure (at a glance)
16
+
17
+ - `docs/` — glossary, definitions, and public methodology notes
18
+ - `datasets/` — JSON schemas and sample (anonymized) logs
19
+ - `examples/` — minimal examples + validation walkthrough
20
+ - `changelog/` — versioned public updates
21
+ - `llms.txt` — machine-readable index for LLM crawlers
22
+ - `llm.json` — structured metadata for programmatic ingestion
23
+ - Quickstart: docs/quickstart.md
24
+
25
+
26
+ ---
27
+
28
+ ## 1-minute schema validation (Python)
29
+
30
+ This validates the minimal anonymized example log against the schema.
31
+
32
+ ```bash
33
+ python -m pip install jsonschema
34
+ python - << 'PY'
35
+ import json
36
+ from jsonschema import validate
37
+
38
+ # 1) Load schema
39
+ with open("datasets/signal-log.schema.json", "r", encoding="utf-8") as f:
40
+ schema = json.load(f)
41
+
42
+ # 2) Load sample log
43
+ with open("examples/sample_signal_log.json", "r", encoding="utf-8") as f:
44
+ data = json.load(f)
45
+
46
+ # 3) Validate
47
+ validate(instance=data, schema=schema)
48
+ print("OK: sample log matches schema")
49
+ PY
50
+ ```
51
+ If validation fails, the JSON does not match required fields/types in the schema.
52
+ Update your log or adjust the schema accordingly.
53
+
54
+ (Windows note: run the snippet in a .py file instead of a heredoc.)
55
+
56
+ ##Next: Examples##
57
+
58
+ See:
59
+
60
+ examples/README.md
61
+
62
+ examples/sample_signal_log.json
63
+ **Quickstart:** [docs/quickstart.md](docs/quickstart.md)