Cerebrum Forex Logo

User Guide

  • Installation
    • Prerequisites
    • Installation via Setup
    • Developer Installation
    • MetaTrader 5 Configuration
    • Verifying the Installation
  • Quick Start
    • Step 1: Connect to MT5
    • Step 2: Data Extraction
    • Step 3: Model Training
    • Step 4: Predictions
    • Signal Interpretation
    • Next Steps
  • User Manual - Cerebrum FX AI
    • Table of Contents
    • Dashboard
      • Dashboard Sub-tabs
      • MT5 Account Info Section
      • Action Buttons
      • Open Positions
    • Prediction Tab
      • Live Operations
      • Signal
    • EA Manager
      • Order Tab
      • Position Tab
      • Risk Tab
      • Prop Firm Tab
      • Trailing Tab
      • EA Logs Tab
      • EA Analytics Tab
    • Dashboard - Sub-tabs
      • Calendar Tab
      • Signals-Chart Tab
      • Trading Tab
    • Extraction
      • OHLC Files Tab
    • Indicators
      • Categories
    • Training
      • Training Pipeline
      • Buttons
      • Model Status
    • Settings
      • General Tab
      • Data Paths Tab
      • AI Signals Tab
      • Logic Tuning Tab
    • Shortcuts and Best Practices
      • Recommended Workflow
      • Prop Firm Tips

API Reference

  • Core Module Reference
    • MT5 Connector
      • MT5Connector
        • MT5Connector.add_callback()
        • MT5Connector.close_all_positions()
        • MT5Connector.connect()
        • MT5Connector.check_health()
        • MT5Connector.disconnect()
        • MT5Connector.test_connection()
        • MT5Connector.preload_history()
        • MT5Connector.get_terminal_data_path()
        • MT5Connector.get_current_server_time()
        • MT5Connector.get_server_time()
        • MT5Connector.get_time_offset()
        • MT5Connector.get_account_info()
        • MT5Connector.get_market_status()
        • MT5Connector.get_ohlc_path()
        • MT5Connector.extract_ohlc()
        • MT5Connector.update_all_ohlc()
        • MT5Connector.get_buffer()
        • MT5Connector.get_latest_candles()
        • MT5Connector.load_ohlc()
        • MT5Connector.load_ohlc_buffer()
        • MT5Connector.get_ohlc_status()
        • MT5Connector.extract_all()
      • get_mt5_connector()
    • Prediction Engine
      • PredictionEngine
        • PredictionEngine.add_callback()
        • PredictionEngine.remove_callback()
        • PredictionEngine.get_signal_path()
        • PredictionEngine.get_enabled_models()
        • PredictionEngine.predict_timeframe()
        • PredictionEngine.load_signal()
        • PredictionEngine.reset_engine()
        • PredictionEngine.predict_all()
        • PredictionEngine.get_prediction_status()
        • PredictionEngine.get_combined_signal()
        • PredictionEngine.get_congress_history()
    • Training Manager
      • TrainingLogBridge
        • TrainingLogBridge.emit()
      • RecoveryRequired
      • TrainingManager
        • TrainingManager.add_callback()
        • TrainingManager.get_model()
        • TrainingManager.get_normalizer()
        • TrainingManager.get_training_status()
        • TrainingManager.should_train_incremental()
        • TrainingManager.prepare_training_data()
        • TrainingManager.train_timeframe()
        • TrainingManager.train_all()
        • TrainingManager.train_with_drift_check()
        • TrainingManager.start_scheduled_training()
        • TrainingManager.stop_scheduled_training()
        • TrainingManager.load_all_models()
    • Feature Engine
      • FeatureEngine
        • FeatureEngine.calculate_all_features()
        • FeatureEngine.get_feature_columns()
        • FeatureEngine.select_best_features()
    • App Controller
      • AppController
        • AppController.mt5
        • AppController.training_manager
        • AppController.prediction_engine
        • AppController.scheduler
        • AppController.start()
        • AppController.stop()
        • AppController.extract_all()
        • AppController.predict_manual()
        • AppController.train_all()
        • AppController.predict_all()
        • AppController.get_signal()
        • AppController.get_combined_signal()
        • AppController.get_ohlc_status()
        • AppController.get_training_status()
        • AppController.get_model()
        • AppController.get_settings()
        • AppController.get_cached_account_info()
        • AppController.save_settings()
        • AppController.get_congress_config()
        • AppController.save_congress_config()
        • AppController.update_scheduler_config()
        • AppController.sync_ea_config()
        • AppController.log_training_event()
    • Noble KPI
      • Noble Safe Range KPI - Core Module
      • MarketRegime
        • MarketRegime.NORMAL
        • MarketRegime.LOW_VOL
        • MarketRegime.HIGH_VOL
        • MarketRegime.CRISIS
      • calculate_atr_series()
      • detect_regime_series()
      • calculate_atr()
      • detect_regime()
      • noble_safe_range()
      • calculate_position()
      • get_recommendation()
      • analyze_timeframe()
      • validate_kpi()
      • calculate_noble_bias()
    • Congress Engine
      • AladdinPersona
        • AladdinPersona.QUANT
        • AladdinPersona.ARCHIVIST
        • AladdinPersona.FUTURIST
        • AladdinPersona.GUARDIAN
        • AladdinPersona.LEADER
        • AladdinPersona.SENTINEL
      • ModelPrediction
        • ModelPrediction.model_name
        • ModelPrediction.model_role
        • ModelPrediction.score
        • ModelPrediction.confidence
        • ModelPrediction.regime
        • ModelPrediction.timeframe
        • ModelPrediction.timestamp
      • CongressDecision
        • CongressDecision.final_signal
        • CongressDecision.final_score
        • CongressDecision.final_confidence
        • CongressDecision.detected_regime
        • CongressDecision.certainty_boost
        • CongressDecision.flux_boost
        • CongressDecision.trend_certainty
        • CongressDecision.duration_tf5
        • CongressDecision.threshold
        • CongressDecision.model_predictions
        • CongressDecision.flux_details
        • CongressDecision.weights_applied
        • CongressDecision.timestamp
        • CongressDecision.override_type
        • CongressDecision.to_dict()
      • CongressEngine
        • CongressEngine.CONGRESS_WEIGHTS
        • CongressEngine.DEFAULT_WEIGHTS
        • CongressEngine.BASE_THRESHOLD
        • CongressEngine.LAMBDA
        • CongressEngine.KPI_GAMMA
        • CongressEngine.CERTAINTY_BONUS
        • CongressEngine.__init__()
        • CongressEngine.detect_market_regime()
        • CongressEngine.calculate_adaptive_threshold()
        • CongressEngine.get_weights()
        • CongressEngine.aggregate()
        • CongressEngine.get_decision_history()
        • CongressEngine.simple_aggregate()
        • CongressEngine.make_decision_batch()
        • CongressEngine.aggregate_with_regime()
        • CongressEngine.full_aggregate()
        • CongressEngine.save_prediction_json()
      • get_congress_engine()
    • Model Scorer
      • PredictionOutcome
        • PredictionOutcome.model_name
        • PredictionOutcome.timeframe
        • PredictionOutcome.predicted_signal
        • PredictionOutcome.actual_outcome
        • PredictionOutcome.confidence
        • PredictionOutcome.timestamp
      • ModelScorer
        • ModelScorer.HISTORY_SIZE
        • ModelScorer.MIN_SAMPLES
        • ModelScorer.DYNAMIC_WEIGHT
        • ModelScorer.EMA_ALPHA
        • ModelScorer.record_outcome()
        • ModelScorer.get_dynamic_weights()
        • ModelScorer.get_model_stats()
      • get_model_scorer()
  • Models Reference
    • XGBoost Model
      • XGBoostModel
        • XGBoostModel.name
        • XGBoostModel.train()
        • XGBoostModel.predict()
        • XGBoostModel.load()
    • LightGBM Model
      • LightGBMModel
        • LightGBMModel.name
        • LightGBMModel.train()
        • LightGBMModel.predict()
        • LightGBMModel.load()
    • RandomForest Model
      • RandomForestModel
        • RandomForestModel.name
        • RandomForestModel.train()
        • RandomForestModel.predict()
        • RandomForestModel.load()
    • Stacking Model
      • StackingModel
        • StackingModel.name
        • StackingModel.train()
        • StackingModel.predict()
        • StackingModel.load()
    • Meta Model
      • MetaModel
        • MetaModel.prepare_meta_features()
        • MetaModel.train()
        • MetaModel.predict_viability()
        • MetaModel.save()
        • MetaModel.load()
  • GUI Reference
    • Main Window
      • MainWindow
        • MainWindow.status_changed
        • MainWindow.update_signal_display()
        • MainWindow.closeEvent()
    • Panels
      • Dashboard Panel
        • PredictionWorker
        • DashboardPanel
      • Extraction Panel
        • ExtractionPanel
      • Training Panel
        • TrainingSignals
        • PhaseCard
        • TrainingPanel
        • SchedulerDialog
      • Prediction Panel
        • PredictionPanel
      • Settings Panel
        • SettingsPanel
    • Workers
      • Prediction Worker
        • PredictionWorker

Resources

  • Changelog
    • Version 1.0.0 (January 2026)
      • New Features
      • Improvements
      • Bug Fixes
  • Contributing
    • How to Contribute
    • Code Style
    • Reporting Bugs
    • Contact
  • Sphinx Documentation System
    • ⚙️ Sphinx Engine
    • 🔍 Parsing
    • 🔗 Reference Resolution
    • 🌳 Tree Generation (RTD Theme)
Cerebrum Forex
  • Search

© Copyright 2026, BMZ Business, LLC.

Built with Sphinx using a theme provided by Read the Docs.