.. Rambling Realms Trading Platform documentation master file, created by
   sphinx-quickstart on Mon Jun  9 11:31:08 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Rambling Realms Trading Platform documentation
==============================================

This app is made to streamline the training, testing, and deploying of machine learning based trading applications (Quant Trading). The end-goal of the application is to provide a hyper generic pipeline for interchanging models, features, training configurations, and strategies all from the command line. The goal of this project is not to outpace existing high frequency trading platforms which leverage low latency, high volume signals, but instead identify long term trends utilizing OHLCV data, sentiment data, gov data, value investment scores, and additional features. You can think of this project more as a full time financial advisor than a trading bot.


.. raw:: html

   <p>
     <a href="https://github.com/mjacobsen32/ramblingrealms-trading" style="color:#ffa500; font-weight:bold; text-decoration:none;">
       🐙 <span style="color:#ffa500;">GitHub</span>
     </a>
     &nbsp;&nbsp;
     <a href="https://ramblingrealms.com/trading" style="color:#ffa500; font-weight:bold; text-decoration:none;">
       🚀 <span style="color:#ffa500;">Production Model</span>
     </a>
   </p>

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   getting_started
   usage
   configuration

Developer Reference
===================
.. toctree::
   :maxdepth: 2
   :caption: Developer Reference:

   profiling