Skip to content

Commit 7c184f8

Browse files
committed
docs: polish README and remove obsolete root-level scripts
1 parent a2a7457 commit 7c184f8

25 files changed

Lines changed: 195 additions & 560 deletions

README.md

Lines changed: 83 additions & 254 deletions
Large diffs are not rendered by default.

THIS_IS_THE_GIT_REPO..txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Push and commit from only this folder.

cli.py

Lines changed: 0 additions & 149 deletions
This file was deleted.
16.8 KB
Loading
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Ragcitecheck instability examples
2+
3+
- Evidence key: **doc**
4+
- Runs: runA, runB
5+
- Queries evaluated: 3
6+
- Flip threshold: J < 0.5
7+
- Min-overlap (stability): 0.5
8+
- allow_missing: False
9+
- topk: None
10+
11+
## q1
12+
- min_overlap_across_pairs: **0.333**
13+
- worst_pair: **runA vs runB**
14+
15+
| run_id | cited_docs (set) |
16+
|---|---|
17+
| runA | d1, d2 |
18+
| runB | d1, d4 |
19+
20+
- worst-pair diff `runA``runB`: J=0.333, flip=YES, +[d4] -[d2]
21+
22+
## q2
23+
- min_overlap_across_pairs: **1.000**
24+
- worst_pair: **N/A**
25+
26+
| run_id | cited_docs (set) |
27+
|---|---|
28+
| runA | d3 |
29+
| runB | d3 |
30+
31+
32+
## q3
33+
- min_overlap_across_pairs: **1.000**
34+
- worst_pair: **N/A**
35+
36+
| run_id | cited_docs (set) |
37+
|---|---|
38+
| runA | (empty) |
39+
| runB | (empty) |
40+
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
config_a,config_b,avg_overlap,flip_rate,null_rate_a,null_rate_b,null_loss_rate_a_to_b,null_gain_rate_a_to_b,stable_at_min_overlap_0.5
2+
runA,runB,0.777778,0.333333,0.333333,0.333333,0.000000,0.000000,1
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
query_id,min_overlap_across_pairs,worst_pair,stable_at_min_overlap_0.5
2+
q1,0.333333,runA vs runB,0
3+
q2,1.000000,N/A,1
4+
q3,1.000000,N/A,1
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"allow_missing": false,
3+
"baseline": null,
4+
"canonicalization": {
5+
"collision_count": 0,
6+
"collisions": null,
7+
"mapped_count": 0,
8+
"unmapped_count": 0
9+
},
10+
"evidence_key": "doc",
11+
"flip_threshold": 0.5,
12+
"min_overlap": 0.5,
13+
"out_dir": "out_report_doc\\doc",
14+
"pairwise_rows": 1,
15+
"query_count": 3,
16+
"run_ids": [
17+
"runA",
18+
"runB"
19+
],
20+
"runs_dir": "tests\\fixtures\\runs_min",
21+
"topk": null,
22+
"warnings": [
23+
"run[0] 'runA' null-citation rate is 33.3% (1/3 queries have empty docs list).",
24+
"run[1] 'runB' null-citation rate is 33.3% (1/3 queries have empty docs list)."
25+
]
26+
}

out_report_doc/doc/run_configs.csv

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
run_id,top_k,chunk_size,chunk_overlap
2+
runA,,,
3+
runB,,,

out_report_doc/doc/run_quality.csv

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
run_id,citation_rate,null_rate,avg_cited_docs,median_cited_docs,p95_cited_docs
2+
runA,0.666667,0.333333,1.000000,1.000,2.000
3+
runB,0.666667,0.333333,1.000000,1.000,2.000

0 commit comments

Comments
 (0)