118 lines
4.8 KiB
HTML
118 lines
4.8 KiB
HTML
<h1>ManeshTrader Help</h1>
|
|
|
|
<h2>What This Tool Does</h2>
|
|
<p>
|
|
The app classifies each closed candle as <code>real_bull</code>, <code>real_bear</code>, or
|
|
<code>fake</code>, then tracks trend state from only the real bars.
|
|
</p>
|
|
<ul>
|
|
<li>2 consecutive real bullish bars: bullish trend active</li>
|
|
<li>2 consecutive real bearish bars: bearish trend active</li>
|
|
<li>Reversal also requires 2 consecutive opposite real bars</li>
|
|
<li>Fake bars do not reverse trend on their own</li>
|
|
</ul>
|
|
|
|
<h2>Quick Start</h2>
|
|
<ol>
|
|
<li>Choose <code>Symbol</code> (example: <code>AAPL</code> or <code>BTC-USD</code>).</li>
|
|
<li>Start with <code>Timeframe = 1d</code> and <code>Period = 6mo</code>.</li>
|
|
<li>Keep <code>Ignore potentially live last bar</code> ON.</li>
|
|
<li>Enable these in <code>Training & Guidance</code>:
|
|
<ul>
|
|
<li><code>Show live decision guide</code></li>
|
|
<li><code>Show past behavior examples</code></li>
|
|
<li><code>Overlay example entries/exits on chart</code></li>
|
|
<li><code>Focus chart on selected example</code> (recommended for learning)</li>
|
|
</ul>
|
|
</li>
|
|
<li>Set <code>Max training examples</code> to 20.</li>
|
|
</ol>
|
|
|
|
<h2>How To Use The New Training Features</h2>
|
|
<p>Training toggles are OFF by default.</p>
|
|
|
|
<h2>Advanced Panels</h2>
|
|
<p>These are in the sidebar as collapsible sections.</p>
|
|
|
|
<h3>Advanced Signals</h3>
|
|
<ul>
|
|
<li><code>Auto-run advanced panels (slower)</code>: keeps advanced calculations running on every rerun.</li>
|
|
<li><code>Run advanced panels now</code>: one-shot run when auto-run is OFF.</li>
|
|
<li><code>Show multi-timeframe confirmation (1h/4h/1d)</code>: shows consensus and agreement %.</li>
|
|
<li><code>Regime filter</code>: flags choppy conditions and can suppress directional bias.</li>
|
|
</ul>
|
|
|
|
<h3>Training & Guidance (Replay)</h3>
|
|
<ul>
|
|
<li><code>Replay mode</code> + <code>Replay bars shown</code>: hides future bars for practice mode.</li>
|
|
</ul>
|
|
|
|
<h3>Compare Symbols</h3>
|
|
<ul>
|
|
<li>Enable panel and enter comma-separated symbols (example: <code>AAPL, MSFT, NVDA</code>).</li>
|
|
<li>Shows per-symbol trend state, regime, and fake-bar density snapshot.</li>
|
|
</ul>
|
|
|
|
<h3>Alerts</h3>
|
|
<ul>
|
|
<li>Enable bullish and/or bearish event alerts.</li>
|
|
<li>Optional webhook URL sends JSON alerts to external automations (Zapier/Make/Telegram bridge).</li>
|
|
</ul>
|
|
|
|
<h3>Backtest Controls</h3>
|
|
<ul>
|
|
<li><code>Slippage (bps per side)</code> and <code>Fee (bps per side)</code>: execution cost realism.</li>
|
|
<li><code>Stop loss (%)</code> and <code>Take profit (%)</code>: optional exits; set 0 to disable.</li>
|
|
<li><code>Min hold bars</code> and <code>Max hold bars</code>: holding window constraints.</li>
|
|
</ul>
|
|
|
|
<h3>1) Live Decision Guide (what to do now)</h3>
|
|
<ul>
|
|
<li><strong>Bias</strong>: Long, Short, or Stand Aside / Neutral.</li>
|
|
<li><strong>Signal Status</strong>: Fresh confirmation or no new confirmation.</li>
|
|
<li><strong>Latest Bar</strong>: How the newest closed candle was classified.</li>
|
|
<li><strong>Action + Invalidation</strong>: Practical rule for what to prefer and when to stop.</li>
|
|
</ul>
|
|
|
|
<h3>2) Past Behavior Examples (what would have happened)</h3>
|
|
<p>
|
|
Examples are hypothetical and use one rule:
|
|
enter at trend-confirmation bar close, exit at opposite trend-confirmation bar close.
|
|
</p>
|
|
<ul>
|
|
<li><code>direction</code>: LONG (upside bias) or SHORT (downside bias)</li>
|
|
<li><code>entry_timestamp</code> / <code>exit_timestamp</code>: example start/end time</li>
|
|
<li><code>entry_price</code> / <code>exit_price</code>: example prices</li>
|
|
<li><code>bars_held</code>: number of candles held</li>
|
|
<li><code>pnl_pct</code>: percent gain/loss for that example</li>
|
|
<li><code>outcome</code>: Win, Loss, or Flat</li>
|
|
</ul>
|
|
|
|
<h3>3) Click A Row To Highlight It On Chart</h3>
|
|
<ol>
|
|
<li>Click any row in the <strong>Past Behavior Examples</strong> table.</li>
|
|
<li>The chart highlights that exact entry-to-exit window.</li>
|
|
<li>A path line shows the selected trade from entry price to exit price.</li>
|
|
<li>A plain-English explanation appears under the table for the selected row.</li>
|
|
<li>If <code>Focus chart on selected example</code> is ON, the chart zooms into that trade.</li>
|
|
</ol>
|
|
|
|
<h2>Marker Legend</h2>
|
|
<ul>
|
|
<li>Green triangle-up: real bullish bar</li>
|
|
<li>Red triangle-down: real bearish bar</li>
|
|
<li>Blue circle: example long entry</li>
|
|
<li>Orange diamond: example short entry</li>
|
|
<li>Green X: example winning exit</li>
|
|
<li>Red X: example loss/flat exit</li>
|
|
<li>Star path + highlighted window: currently selected example row</li>
|
|
</ul>
|
|
|
|
<h2>Important Notes</h2>
|
|
<ul>
|
|
<li>On browser refresh, a brief placeholder screen can appear while Streamlit loads the app shell.</li>
|
|
<li>Analysis and training only. No trade execution.</li>
|
|
<li>Educational examples are simplified and not financial advice.</li>
|
|
<li>Use with risk controls before any real-money decision.</li>
|
|
</ul>
|