upliftlab 0.26.2__tar.gz → 0.26.3__tar.gz

{upliftlab-0.26.2 → upliftlab-0.26.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: upliftlab
-Version: 0.26.2
+Version: 0.26.3
 Summary: Find the uplift model that gives the most incremental outcome for the same budget, on your own experiment data
 License-Expression: MIT
 Project-URL: Homepage, https://uplift-lab.vercel.app

{upliftlab-0.26.2 → upliftlab-0.26.3}/engine/upliftlab/__init__.py

@@ -2,4 +2,4 @@
 
 The same package runs in the browser (Pyodide) and natively (`python -m upliftlab serve`).
 """
-__version__ = '0.26.2'
+__version__ = '0.26.3'

{upliftlab-0.26.2 → upliftlab-0.26.3}/engine/upliftlab/__main__.py

@@ -77,28 +77,48 @@ def main(argv=None):
         print(f'{dataset} · {len(algorithms)} algorithms · {args.cycles} cycles · device {devices[0]}', file=sys.stderr)
         bridge.set_reporter(lambda m: (lambda d: d.get('phase') == 'done' and print(f"  c{d['cycle']} {d['arm']} done", file=sys.stderr))(json.loads(m)))
         result = bridge.run_all(dataset, algorithms, args.cycles, args.explore, args.target, args.seed, args.mode, args.budget, args.base_learner, args.efficiency)
-        by = result['summary']['by']
-        measure = ('incremental' if by.lower().endswith('incr') else 'gain') + (' (truth)' if by.startswith('truth') else ' (observed)')
-        volume = by.lower().endswith('incr')  # ranked by incremental outcome: the band is the gap to first place, as on the screen
-        print(f"\n{'rank':<5}{'algorithm':<26}{measure:>22}{'vs 1st, 95% CI' if volume else 'observed 95% CI':>30}{'AUCC':>8}{'Qini':>8}{'fit ms':>9}")
-        for s in sorted(result['summary']['arms'], key=lambda s: s['rank']):
-            g, ci, auc, ms = s[by], s['ci'], s['aucc'], s['trainMs']
-            gain = '—' if g is None else f'{g:,.0f}' if volume else f'{g:+.1%}'
-            q = '—' if s['qini'] is None else f"{s['qini']:.3f}"
-            gap = s.get('vsLeader') or {}
-            if volume:
-                band = '1st' if s['rank'] == 1 else '—' if gap.get('diff') is None or gap.get('ci', [None])[0] is None else f"{gap['diff']:+,.0f} [{gap['ci'][0]:+,.0f}, {gap['ci'][1]:+,.0f}]"
-            else:
-                band = '—' if ci[0] is None else f'[{ci[0]:+.1%}, {ci[1]:+.1%}]'
-            auc = '—' if auc is None else f'{auc:.3f}'
-            ms = '—' if ms is None else f'{ms:.0f}'
-            print(f"{s['rank']:<5}{s['name'][:25]:<26}{gain:>22}{band:>30}{auc:>8}{q:>8}{ms:>9}")
+        print('\n' + '\n'.join(table(result)))
         print('\n' + conclusion(result, args.mode))
         if args.out:
             Path(args.out).write_text(json.dumps({'format': 'upliftlab.run/1', **result}, ensure_ascii=False))
             print(f'\nwrote {args.out}', file=sys.stderr)
 
 
+def table(result):
+    """The ranking as lines of text. The second header line names each column's basis. The ranked value, its gap to first
+    place, AUCC and Qini use the ranking's basis; the 95% CI is always observed, since only observed data has sampling
+    error. With synthetic data that adds the observed gap as its own column, which is what an experiment would have shown."""
+    arms, by = result['summary']['arms'], result['summary']['by']
+    truth, volume = by.startswith('truth'), by.lower().endswith('incr')
+    basis, lead = ('truth' if truth else 'observed'), min(arms, key=lambda s: s['rank'])
+    dash = '—'
+    fix = lambda v, f: dash if v is None else format(v, f)  # noqa: E731
+
+    def observed_gap(s):
+        gap = s.get('vsLeader') or {}
+        if s['rank'] == 1:
+            return '1st'
+        if gap.get('diff') is None or (gap.get('ci') or [None])[0] is None:
+            return dash
+        return f"{gap['diff']:+,.0f} [{gap['ci'][0]:+,.0f}, {gap['ci'][1]:+,.0f}]"
+
+    columns = [('incremental' if volume else 'gain', basis, 13, lambda s: fix(s[by], ',.0f' if volume else '+.1%'))]
+    if volume and truth:
+        columns.append(('vs 1st', 'truth', 10, lambda s: '1st' if s['rank'] == 1 else dash if s[by] is None or lead[by] is None else f'{s[by] - lead[by]:+,.0f}'))
+    if volume:
+        columns.append(('vs 1st, 95% CI', 'observed', 26, observed_gap))
+    else:
+        columns.append(('95% CI', 'observed', 20, lambda s: dash if s['ci'][0] is None else f"[{s['ci'][0]:+.1%}, {s['ci'][1]:+.1%}]"))
+    columns += [('AUCC', basis, 10, lambda s: fix(s['auccTruth' if truth else 'aucc'], '.3f')),
+                ('Qini', basis, 10, lambda s: fix(s['qiniTruth' if truth else 'qini'], '.3f')),
+                ('fit ms', '', 8, lambda s: fix(s['trainMs'], '.0f'))]
+    lines = [f"{'rank':<5}{'algorithm':<26}" + ''.join(f'{name:>{w}}' for name, _, w, _ in columns),
+             ' ' * 31 + ''.join(f'{b:>{w}}' for _, b, w, _ in columns)]
+    for s in sorted(arms, key=lambda s: s['rank']):
+        lines.append(f"{s['rank']:<5}{s['name'][:25]:<26}" + ''.join(f'{cell(s):>{w}}' for _, _, w, cell in columns))
+    return lines
+
+
 def conclusion(result, mode):
     """One line under the table: who won, by how much over Random, on which basis."""
     arms, by = result['summary']['arms'], result['summary']['by']

{upliftlab-0.26.2 → upliftlab-0.26.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "upliftlab"
-version = "0.26.2"
+version = "0.26.3"
 description = "Find the uplift model that gives the most incremental outcome for the same budget, on your own experiment data"
 requires-python = ">=3.10"
 readme = "README.md"

{upliftlab-0.26.2 → upliftlab-0.26.3}/tests/test_engine.py

@@ -17,6 +17,7 @@ from upliftlab.arena import Run, knapsack, select, best_cutoff  # noqa: E402
 from upliftlab.arena import cost_estimator  # noqa: E402
 from upliftlab.metrics import aucc, cost_curve, pooled, qini, qini_draws, qini_of_draws, uplift_at  # noqa: E402
 from upliftlab.scenario import ReplayScenario, SyntheticScenario  # noqa: E402
+from upliftlab.__main__ import table  # noqa: E402
 
 BUILTINS = {a['id']: {'id': a['id'], 'name': a['name'], 'code': a['code']} for a in bridge.builtins()}
 TEMPLATES = {t['id']: t for t in bridge.templates()}
@@ -216,6 +217,27 @@ def test_ranking_does_not_depend_on_the_units_of_cost_or_outcome(algorithm):
         assert other_gain == pytest.approx(gain, abs=1e-9), units
 
 
+def test_the_command_line_table_ranks_and_measures_gaps_on_one_basis():
+    def arm(rank, name, truth, observed, gap=None):
+        return {'rank': rank, 'name': name, 'truthIncR': truth, 'incR': observed, 'ci': [None, None], 'trainMs': 5., 'aucc': .51, 'auccTruth': .61, 'qini': .02, 'qiniTruth': .04,
+                'vsLeader': None if gap is None else {'diff': gap, 'ci': [gap - 100, gap + 100], 'tied': False}}
+    synthetic = {'summary': {'by': 'truthIncR', 'arms': [arm(1, 'R-Learner', 2342., 2500.), arm(2, 'Random', 2172., 2139., gap=-361.)]}}
+    head, basis, first, second = table(synthetic)
+    assert head.split()[2:] == ['incremental', 'vs', '1st', 'vs', '1st,', '95%', 'CI', 'AUCC', 'Qini', 'fit', 'ms']
+    assert basis.split() == ['truth', 'truth', 'observed', 'truth', 'truth'], 'every column names its basis'
+    assert second.split()[2:6] == ['2,172', '-170', '-361', '[-461,'], 'the gap to first place is on the ranking basis, the observed one is its own column'
+    assert '0.610' in second and '0.040' in second, 'AUCC and Qini follow the ranking basis'
+    observed = {'summary': {'by': 'incR', 'arms': [arm(1, 'R-Learner', None, 2500.), arm(2, 'Random', None, 2139., gap=-361.)]}}
+    head, basis, first, second = table(observed)
+    assert basis.split() == ['observed', 'observed', 'observed', 'observed'] and second.split()[2:4] == ['2,139', '-361']
+    assert '0.510' in second and '0.020' in second
+    run = call('run_all', dataset='synthetic/base', algorithms=pick('r_learner', 'random_baseline'), cycles=3, mode='budget')
+    lines, s = table(run), sorted(run['summary']['arms'], key=lambda a: a['rank'])
+    assert lines[3].split()[3] == f"{s[1]['truthIncR'] - s[0]['truthIncR']:+,.0f}"
+    by_gain = table(call('run_all', dataset='synthetic/base', algorithms=pick('r_learner', 'random_baseline'), cycles=3))
+    assert by_gain[0].split()[2:4] == ['gain', '95%'] and by_gain[1].split() == ['truth', 'observed', 'truth', 'truth']
+
+
 def test_qini_and_uplift_at_k_follow_their_definitions():
     line = [{'f': f, 'cost': f * 10, 'value': f * 4} for f in (0, .25, .5, .75, 1)]
     assert qini(line) == pytest.approx(0), 'a straight line is random targeting'

{upliftlab-0.26.2 → upliftlab-0.26.3}/upliftlab.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: upliftlab
-Version: 0.26.2
+Version: 0.26.3
 Summary: Find the uplift model that gives the most incremental outcome for the same budget, on your own experiment data
 License-Expression: MIT
 Project-URL: Homepage, https://uplift-lab.vercel.app

{upliftlab-0.26.2 → upliftlab-0.26.3}/web/app.js

@@ -1,9 +1,9 @@
 // Shell: header, router and the engine chip. Views live in ./views and read from ./store.
-import {$, esc, go} from './lib.js?v=0.26.2';
-import {state, subscribe, boot, running} from './store.js?v=0.26.2';
-import {workspaceView} from './views/workspace.js?v=0.26.2';
-import {algorithmsView} from './views/algorithms.js?v=0.26.2';
-import {dataView} from './views/data.js?v=0.26.2';
+import {$, esc, go} from './lib.js?v=0.26.3';
+import {state, subscribe, boot, running} from './store.js?v=0.26.3';
+import {workspaceView} from './views/workspace.js?v=0.26.3';
+import {algorithmsView} from './views/algorithms.js?v=0.26.3';
+import {dataView} from './views/data.js?v=0.26.3';
 
 const routes = [
   [/^\/?$/, workspaceView, () => ({})],