Skip to content

docs: README describes shipped library and runnable commands - #17

Merged
mrnicholasbcarter-code merged 2 commits into
masterfrom
docs/readme-matches-shipped-api
Sep 24, 2026
Merged

mrnicholasbcarter-code merged 2 commits into
masterfrom
docs/readme-matches-shipped-api

Conversation

@mrnicholasbcarter-code

Copy link
Copy Markdown
Owner

The README described features and commands that the repository does not ship. An interviewer copying the quick start would hit errors immediately.

README claimed Reality
pipx install verdict-edge Not on PyPI (pypi.org/pypi/verdict-edge/json → 404)
verdict-edge mine --config config/alpha_pipeline.yaml --backtest No [project.scripts]; no CLI; no config/ dir
Ingestion (Polymarket websocket), Execution Gateway, retries Not implemented; library evaluates plain dicts only
Filter pipeline with AND/OR/NOT AND-only compound rules (evaluate_compound)
Feature pipeline: rolling stats, regime detection, microstructure Series operators (zscore, rolling_corr, rank, crosses) only
"Native verdict-risk gate", "Backtest native tearsheet", OpenTelemetry spans No imports / no otel dependency
Links to RuVector / Ruflo No code dependency

The new README describes what ships: FeatureEvaluator, ExpectedValueGate, and build_strategy_receipt, with source paths and scope boundaries. The quick start is from source.

Verified on this branch:

  • README Python snippet runs → True 7.81 0.1565
  • uv run python examples/gate_kalshi.py and examples/run_evaluator.py run
  • uv run --locked pytest -q → 53 passed, 2 skipped
  • git diff --check clean

Docs only; no code changes.

@mrnicholasbcarter-code
mrnicholasbcarter-code merged commit c1ba1a4 into master Sep 24, 2026
10 checks passed
@mrnicholasbcarter-code
mrnicholasbcarter-code deleted the docs/readme-matches-shipped-api branch September 24, 2026 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant