Skip to content

Commit 1c949d3

Browse files
authored
Merge pull request #8 from kiploks/ui-for-analyze
docs: add UI testing feature
2 parents dcf5cfe + 14a9e57 commit 1c949d3

85 files changed

Lines changed: 15414 additions & 875 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1616
- `buildPathMonteCarloSimulation` in `@kiploks/engine-core`: path-based i.i.d. bootstrap over equity period returns; CAGR and max drawdown distributions, labels, `interpretation`, `meta` (`PATH_MONTE_CARLO_METHOD_VERSION`, currently **1.1.0**).
1717
- `calculateCagrFromYears` in `financialMath.ts`.
1818
- Contract types in `@kiploks/engine-contracts`: `PathMonteCarloResult`, `PathMonteCarloOptions`, `PathMonteCarloEquityPoint`, `DistributionStats` (incl. optional `varCornishFisher95`), extended `PathMonteCarloMeta`.
19-
- `packages/core/src/prng.ts` shared `createMulberry32` (path MC, professional window bootstrap, WFE).
19+
- `packages/core/src/prng.ts` - shared `createMulberry32` (path MC, professional window bootstrap, WFE).
2020
- `AnalyzeConfig.monteCarloBootstrapN` for precomputed `analyzeFromWindows` (professional `monteCarloValidation` iterations; default 1000, clamp 100-50000).
2121
- Docs: `MONTE_CARLO_PATH.md`, `MONTE_CARLO_SIMULATION_IMPLEMENTATION.md`, `examples/monte-carlo-example.md`, golden `examples/monte-carlo-seed42.json`, `npm run engine:examples:generate-monte-carlo-fixture`. Demo tab in `examples/result-layout-demo.html`.
2222

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
1-
# Kiploks Engine (Open Core)
1+
# Kiploks Trading Robustness Engine (Open Core)
2+
3+
## ✨ New: easier Freqtrade bot testing in UI
4+
5+
You can now run Freqtrade bot tests directly from the web interface with much less setup friction.
6+
7+
https://github.com/user-attachments/assets/b376f964-ab70-44ef-b8f6-bc3fd19f4e21
8+
9+
```bash
10+
npm install
11+
npm run ui
12+
# or without global install:
13+
npx -y @kiploks/engine-cli ui --watch
14+
```
15+
16+
17+
- Pick a specific backtest artifact from the list, or run in `Auto (top_n)` mode.
18+
- Start integration runs from a cleaner Step 4 workspace with collapsible sections.
19+
- Get report links in run logs after successful local runs, so you can open results right away.
20+
- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/engine/blob/main/docs/BOT_INTEGRATIONS.md) modes.
21+
222

323
[![npm](https://img.shields.io/npm/v/@kiploks/engine-core)](https://www.npmjs.com/package/@kiploks/engine-core)
424
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)

docs/ENTRYPOINTS.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Optional **`equityCurve`** on the input can help unlock benchmark-related paths
148148

149149
## Troubleshooting: `available: false` and warnings
150150

151-
A block with **`available: false`** is **not a crash** it means the engine **refuses to fake** that block because required inputs are missing. Read **`reason`** on the block (`KiploksUnavailableReason` in [`packages/contracts/src/errors.ts`](../packages/contracts/src/errors.ts)).
151+
A block with **`available: false`** is **not a crash** - it means the engine **refuses to fake** that block because required inputs are missing. Read **`reason`** on the block (`KiploksUnavailableReason` in [`packages/contracts/src/errors.ts`](../packages/contracts/src/errors.ts)).
152152

153153
For **behavioral cautions** (low trade count, low window count, weak p-value, etc.), see **`warnings[]`** on the result and the full **[`ERROR_CATALOG.md`](ERROR_CATALOG.md)**.
154154

@@ -167,8 +167,8 @@ When contracts change, **this file can go stale**. Prefer:
167167

168168
## See also
169169

170-
- **[`OPEN_CORE_INTEGRATION_PRINCIPLES.md`](OPEN_CORE_INTEGRATION_PRINCIPLES.md)** design principles and `runEverything()`.
171-
- **[`examples-map-payload-to-unified.md`](examples-map-payload-to-unified.md)** `mapPayloadToUnified` and CSV-first flow.
172-
- **[`examples/README.md`](examples/README.md)** step-by-step examples.
173-
- **[`ERROR_CATALOG.md`](ERROR_CATALOG.md)** warning and error codes.
174-
- **[`MONTE_CARLO_SIMULATION_IMPLEMENTATION.md`](MONTE_CARLO_SIMULATION_IMPLEMENTATION.md)** path MC vs window bootstrap index.
170+
- **[`OPEN_CORE_INTEGRATION_PRINCIPLES.md`](OPEN_CORE_INTEGRATION_PRINCIPLES.md)** - design principles and `runEverything()`.
171+
- **[`examples-map-payload-to-unified.md`](examples-map-payload-to-unified.md)** - `mapPayloadToUnified` and CSV-first flow.
172+
- **[`examples/README.md`](examples/README.md)** - step-by-step examples.
173+
- **[`ERROR_CATALOG.md`](ERROR_CATALOG.md)** - warning and error codes.
174+
- **[`MONTE_CARLO_SIMULATION_IMPLEMENTATION.md`](MONTE_CARLO_SIMULATION_IMPLEMENTATION.md)** - path MC vs window bootstrap index.

0 commit comments

Comments
 (0)