Neureonmindflux-Research-Lab · HectorMozo3110 · Oct 27, 2025 · Oct 27, 2025
diff --git a/docs/architecture.rst b/docs/architecture.rst
@@ -0,0 +1,11 @@
+Architecture
+============
+
+This section describes the internal design of QML-HCS, including its modular
+quantum-classical architecture and interaction between core components.
+
+
+.. warning::
+
+   🚧 These sections are currently under active development.  
+   Content will be expanded soon with detailed explanations, diagrams, and examples.
diff --git a/docs/benchmarks.rst b/docs/benchmarks.rst
@@ -0,0 +1,11 @@
+Benchmarks / Performance
+========================
+
+This section presents benchmark results comparing QML-HCS to classical
+machine learning models, highlighting speed, efficiency, and scalability.
+
+
+.. warning::
+
+   🚧 These sections are currently under active development.  
+   Content will be expanded soon with detailed explanations, diagrams, and examples.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1,9 @@
+Changelog / Versioning
+======================
+
+Version history and updates for QML-HCS.
+
+.. warning::
+
+   🚧 These sections are currently under active development.  
+   Content will be expanded soon with detailed explanations, diagrams, and examples.
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -1,7 +1,7 @@
 .. _examples:
 
-Examples
-========
+Quickstart / Tutorials
+======================
 
 This section contains independent runnable examples of the QML-HCS system.
 Each link below opens a separate page with the full documentation of that example.

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -1,7 +1,7 @@
 .. _getting_started:
 
-Getting Started
-===============
+Installation
+============
 
 This section guides you through installing, configuring, and verifying **QML-HCS** —  
 the *Quantum Machine Learning Hypercausal System*.  

diff --git a/docs/index.rst b/docs/index.rst
@@ -42,12 +42,19 @@ Welcome. Explore the examples, modules, and benchmark studies to understand how
    :caption: Contents
    :hidden:
 
+   Overview <self>
    getting_started
    examples
+   architecture
+   theory
+   integration
+   benchmarks
+   changelog
    contributing
-   source/modules
+   modules/api_overview
    GitHub Repository <https://github.com/Neureonmindflux-Research-Lab/qml-hcs>
 
 
 
 
+
diff --git a/docs/integration.rst b/docs/integration.rst
@@ -0,0 +1,11 @@
+Integration
+===========
+
+This section shows how QML-HCS integrates with external frameworks such as
+Qiskit, PennyLane, and PyTorch for hybrid workflows.
+
+
+.. warning::
+
+   🚧 These sections are currently under active development.  
+   Content will be expanded soon with detailed explanations, diagrams, and examples.
diff --git a/docs/modules/api_overview.rst b/docs/modules/api_overview.rst
@@ -0,0 +1,17 @@
+API Overview
+============
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+
+   Backends <qmlhc/backends/index>
+   Callbacks <qmlhc/callbacks/index>
+   Core Engine <qmlhc/core/index>
+   Examples <qmlhc/examples/index>
+   Hypercausal Graph <qmlhc/hc/index>
+   Loss Functions <qmlhc/loss/index>
+   Metrics <qmlhc/metrics/index>
+   Optimization <qmlhc/optim/index>
+   Predictors <qmlhc/predictors/index>
+
diff --git a/docs/modules/qmlhc/backends/index.rst b/docs/modules/qmlhc/backends/index.rst
@@ -0,0 +1,14 @@
+Backends
+========
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   C++ Backend (pybind11) <qmlhc.backends.cpp_backend>
+   PennyLane Backend <qmlhc.backends.pennylane_backend>
+   Qiskit Backend <qmlhc.backends.qiskit_backend>
+
diff --git a/docs/modules/qmlhc/backends/qmlhc.backends.cpp_backend.rst b/docs/modules/qmlhc/backends/qmlhc.backends.cpp_backend.rst
@@ -0,0 +1,8 @@
+C++ Backend (pybind11)
+======================
+
+.. automodule:: qmlhc.backends.cpp_backend
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/backends/qmlhc.backends.pennylane_backend.rst b/docs/modules/qmlhc/backends/qmlhc.backends.pennylane_backend.rst
@@ -0,0 +1,8 @@
+PennyLane Backend
+=================
+
+.. automodule:: qmlhc.backends.pennylane_backend
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/backends/qmlhc.backends.qiskit_backend.rst b/docs/modules/qmlhc/backends/qmlhc.backends.qiskit_backend.rst
@@ -0,0 +1,8 @@
+Qiskit Backend
+==============
+
+.. automodule:: qmlhc.backends.qiskit_backend
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/callbacks/index.rst b/docs/modules/qmlhc/callbacks/index.rst
@@ -0,0 +1,14 @@
+Callbacks
+=========
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   Callback Base Classes <qmlhc.callbacks.base>
+   Depth Control Callback <qmlhc.callbacks.depth_control>
+   Telemetry Callback <qmlhc.callbacks.telemetry>
+
diff --git a/docs/modules/qmlhc/callbacks/qmlhc.callbacks.base.rst b/docs/modules/qmlhc/callbacks/qmlhc.callbacks.base.rst
@@ -0,0 +1,8 @@
+Callback Base Classes
+=====================
+
+.. automodule:: qmlhc.callbacks.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/callbacks/qmlhc.callbacks.depth_control.rst b/docs/modules/qmlhc/callbacks/qmlhc.callbacks.depth_control.rst
@@ -0,0 +1,8 @@
+Depth Control Callback
+======================
+
+.. automodule:: qmlhc.callbacks.depth_control
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/callbacks/qmlhc.callbacks.telemetry.rst b/docs/modules/qmlhc/callbacks/qmlhc.callbacks.telemetry.rst
@@ -0,0 +1,8 @@
+Telemetry Callback
+==================
+
+.. automodule:: qmlhc.callbacks.telemetry
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/core/index.rst b/docs/modules/qmlhc/core/index.rst
@@ -0,0 +1,15 @@
+Core Engine
+===========
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   Backend Interface <qmlhc.core.backend>
+   Quantum Model Abstractions <qmlhc.core.model>
+   Backend Registry <qmlhc.core.registry>
+   Core Types <qmlhc.core.types>
+
diff --git a/docs/modules/qmlhc/core/qmlhc.core.backend.rst b/docs/modules/qmlhc/core/qmlhc.core.backend.rst
@@ -0,0 +1,8 @@
+Backend Interface
+=================
+
+.. automodule:: qmlhc.core.backend
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/core/qmlhc.core.model.rst b/docs/modules/qmlhc/core/qmlhc.core.model.rst
@@ -0,0 +1,8 @@
+Quantum Model Abstractions
+==========================
+
+.. automodule:: qmlhc.core.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/core/qmlhc.core.registry.rst b/docs/modules/qmlhc/core/qmlhc.core.registry.rst
@@ -0,0 +1,8 @@
+Backend Registry
+================
+
+.. automodule:: qmlhc.core.registry
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/core/qmlhc.core.types.rst b/docs/modules/qmlhc/core/qmlhc.core.types.rst
@@ -0,0 +1,8 @@
+Core Types
+==========
+
+.. automodule:: qmlhc.core.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/examples/index.rst b/docs/modules/qmlhc/examples/index.rst
@@ -0,0 +1,12 @@
+Examples
+========
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   Minimal Core Demo <qmlhc.examples.ex_minimal_core_demo>
+
diff --git a/docs/modules/qmlhc/examples/qmlhc.examples.ex_minimal_core_demo.rst b/docs/modules/qmlhc/examples/qmlhc.examples.ex_minimal_core_demo.rst
@@ -0,0 +1,8 @@
+Minimal Core Demo
+=================
+
+.. automodule:: qmlhc.examples.ex_minimal_core_demo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/hc/index.rst b/docs/modules/qmlhc/hc/index.rst
@@ -0,0 +1,14 @@
+Hypercausal Graph
+=================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   Hypercausal Graph <qmlhc.hc.graph>
+   Hypercausal Node <qmlhc.hc.node>
+   Hypercausal Policy <qmlhc.hc.policy>
+
diff --git a/docs/modules/qmlhc/hc/qmlhc.hc.graph.rst b/docs/modules/qmlhc/hc/qmlhc.hc.graph.rst
@@ -0,0 +1,8 @@
+Hypercausal Graph
+=================
+
+.. automodule:: qmlhc.hc.graph
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/hc/qmlhc.hc.node.rst b/docs/modules/qmlhc/hc/qmlhc.hc.node.rst
@@ -0,0 +1,8 @@
+Hypercausal Node
+================
+
+.. automodule:: qmlhc.hc.node
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/hc/qmlhc.hc.policy.rst b/docs/modules/qmlhc/hc/qmlhc.hc.policy.rst
@@ -0,0 +1,8 @@
+Hypercausal Policy
+==================
+
+.. automodule:: qmlhc.hc.policy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/index.rst b/docs/modules/qmlhc/index.rst
@@ -0,0 +1,20 @@
+API Overview
+============
+
+Subpackages
+------------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   Backends <backends/index>
+   Callbacks <callbacks/index>
+   Core Engine <core/index>
+   Examples <examples/index>
+   Hypercausal Graph <hc/index>
+   Loss Functions <loss/index>
+   Metrics <metrics/index>
+   Optimization <optim/index>
+   Predictors <predictors/index>
+
diff --git a/docs/modules/qmlhc/loss/index.rst b/docs/modules/qmlhc/loss/index.rst
@@ -0,0 +1,14 @@
+Loss Functions
+==============
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   Coherence Loss <qmlhc.loss.coherence>
+   Consistency Loss <qmlhc.loss.consistency>
+   Task Loss <qmlhc.loss.task>
+
diff --git a/docs/modules/qmlhc/loss/qmlhc.loss.coherence.rst b/docs/modules/qmlhc/loss/qmlhc.loss.coherence.rst
@@ -0,0 +1,8 @@
+Coherence Loss
+==============
+
+.. automodule:: qmlhc.loss.coherence
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/loss/qmlhc.loss.consistency.rst b/docs/modules/qmlhc/loss/qmlhc.loss.consistency.rst
@@ -0,0 +1,8 @@
+Consistency Loss
+================
+
+.. automodule:: qmlhc.loss.consistency
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/loss/qmlhc.loss.task.rst b/docs/modules/qmlhc/loss/qmlhc.loss.task.rst
@@ -0,0 +1,8 @@
+Task Loss
+=========
+
+.. automodule:: qmlhc.loss.task
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/modules/qmlhc/metrics/index.rst b/docs/modules/qmlhc/metrics/index.rst
@@ -0,0 +1,14 @@
+Metrics
+=======
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   Anomaly Metrics <qmlhc.metrics.anomalies>
+   Control Metrics <qmlhc.metrics.control>
+   Forecasting Metrics <qmlhc.metrics.forecasting>
+
diff --git a/docs/modules/qmlhc/metrics/qmlhc.metrics.anomalies.rst b/docs/modules/qmlhc/metrics/qmlhc.metrics.anomalies.rst
@@ -0,0 +1,8 @@
+Anomaly Metrics
+===============
+
+.. automodule:: qmlhc.metrics.anomalies
+   :members:
+   :undoc-members:
+   :show-inheritance:
+