diff --git a/docs/architecture.rst b/docs/architecture.rst new file mode 100644 index 0000000..d36b5e6 --- /dev/null +++ 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 new file mode 100644 index 0000000..a15ea46 --- /dev/null +++ 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 new file mode 100644 index 0000000..4bb984c --- /dev/null +++ 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 index 50af946..727d4f8 100644 --- 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 index eea1520..9a8cb6c 100644 --- 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 index 776e7bb..ac4290f 100644 --- 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 getting_started examples + architecture + theory + integration + benchmarks + changelog contributing - source/modules + modules/api_overview GitHub Repository + diff --git a/docs/integration.rst b/docs/integration.rst new file mode 100644 index 0000000..cb5fd54 --- /dev/null +++ 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 new file mode 100644 index 0000000..1260a8b --- /dev/null +++ b/docs/modules/api_overview.rst @@ -0,0 +1,17 @@ +API Overview +============ + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + Backends + Callbacks + Core Engine + Examples + Hypercausal Graph + Loss Functions + Metrics + Optimization + Predictors + diff --git a/docs/modules/qmlhc/backends/index.rst b/docs/modules/qmlhc/backends/index.rst new file mode 100644 index 0000000..a202fa9 --- /dev/null +++ b/docs/modules/qmlhc/backends/index.rst @@ -0,0 +1,14 @@ +Backends +======== + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + C++ Backend (pybind11) + PennyLane Backend + Qiskit Backend + diff --git a/docs/modules/qmlhc/backends/qmlhc.backends.cpp_backend.rst b/docs/modules/qmlhc/backends/qmlhc.backends.cpp_backend.rst new file mode 100644 index 0000000..2297306 --- /dev/null +++ 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 new file mode 100644 index 0000000..9b281fa --- /dev/null +++ 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 new file mode 100644 index 0000000..37d2a43 --- /dev/null +++ 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 new file mode 100644 index 0000000..c4658d5 --- /dev/null +++ b/docs/modules/qmlhc/callbacks/index.rst @@ -0,0 +1,14 @@ +Callbacks +========= + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Callback Base Classes + Depth Control Callback + Telemetry Callback + diff --git a/docs/modules/qmlhc/callbacks/qmlhc.callbacks.base.rst b/docs/modules/qmlhc/callbacks/qmlhc.callbacks.base.rst new file mode 100644 index 0000000..8d10c51 --- /dev/null +++ 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 new file mode 100644 index 0000000..137972a --- /dev/null +++ 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 new file mode 100644 index 0000000..f2994f2 --- /dev/null +++ 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 new file mode 100644 index 0000000..4925c85 --- /dev/null +++ b/docs/modules/qmlhc/core/index.rst @@ -0,0 +1,15 @@ +Core Engine +=========== + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Backend Interface + Quantum Model Abstractions + Backend Registry + Core Types + diff --git a/docs/modules/qmlhc/core/qmlhc.core.backend.rst b/docs/modules/qmlhc/core/qmlhc.core.backend.rst new file mode 100644 index 0000000..8fa05f5 --- /dev/null +++ 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 new file mode 100644 index 0000000..bec5b2a --- /dev/null +++ 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 new file mode 100644 index 0000000..6cda2f5 --- /dev/null +++ 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 new file mode 100644 index 0000000..7e2a38d --- /dev/null +++ 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 new file mode 100644 index 0000000..2c14c85 --- /dev/null +++ b/docs/modules/qmlhc/examples/index.rst @@ -0,0 +1,12 @@ +Examples +======== + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + 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 new file mode 100644 index 0000000..4bd91a0 --- /dev/null +++ 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 new file mode 100644 index 0000000..5f45359 --- /dev/null +++ b/docs/modules/qmlhc/hc/index.rst @@ -0,0 +1,14 @@ +Hypercausal Graph +================= + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Hypercausal Graph + Hypercausal Node + Hypercausal Policy + diff --git a/docs/modules/qmlhc/hc/qmlhc.hc.graph.rst b/docs/modules/qmlhc/hc/qmlhc.hc.graph.rst new file mode 100644 index 0000000..246ebb5 --- /dev/null +++ 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 new file mode 100644 index 0000000..bb5db81 --- /dev/null +++ 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 new file mode 100644 index 0000000..01eeab7 --- /dev/null +++ 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 new file mode 100644 index 0000000..e977d04 --- /dev/null +++ b/docs/modules/qmlhc/index.rst @@ -0,0 +1,20 @@ +API Overview +============ + +Subpackages +------------ + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Backends + Callbacks + Core Engine + Examples + Hypercausal Graph + Loss Functions + Metrics + Optimization + Predictors + diff --git a/docs/modules/qmlhc/loss/index.rst b/docs/modules/qmlhc/loss/index.rst new file mode 100644 index 0000000..b1e3579 --- /dev/null +++ b/docs/modules/qmlhc/loss/index.rst @@ -0,0 +1,14 @@ +Loss Functions +============== + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Coherence Loss + Consistency Loss + Task Loss + diff --git a/docs/modules/qmlhc/loss/qmlhc.loss.coherence.rst b/docs/modules/qmlhc/loss/qmlhc.loss.coherence.rst new file mode 100644 index 0000000..053ceb7 --- /dev/null +++ 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 new file mode 100644 index 0000000..c2d127c --- /dev/null +++ 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 new file mode 100644 index 0000000..e510c21 --- /dev/null +++ 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 new file mode 100644 index 0000000..79050e9 --- /dev/null +++ b/docs/modules/qmlhc/metrics/index.rst @@ -0,0 +1,14 @@ +Metrics +======= + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Anomaly Metrics + Control Metrics + Forecasting Metrics + diff --git a/docs/modules/qmlhc/metrics/qmlhc.metrics.anomalies.rst b/docs/modules/qmlhc/metrics/qmlhc.metrics.anomalies.rst new file mode 100644 index 0000000..a20d0cc --- /dev/null +++ b/docs/modules/qmlhc/metrics/qmlhc.metrics.anomalies.rst @@ -0,0 +1,8 @@ +Anomaly Metrics +=============== + +.. automodule:: qmlhc.metrics.anomalies + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/modules/qmlhc/metrics/qmlhc.metrics.control.rst b/docs/modules/qmlhc/metrics/qmlhc.metrics.control.rst new file mode 100644 index 0000000..13793a0 --- /dev/null +++ b/docs/modules/qmlhc/metrics/qmlhc.metrics.control.rst @@ -0,0 +1,8 @@ +Control Metrics +=============== + +.. automodule:: qmlhc.metrics.control + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/modules/qmlhc/metrics/qmlhc.metrics.forecasting.rst b/docs/modules/qmlhc/metrics/qmlhc.metrics.forecasting.rst new file mode 100644 index 0000000..9c11f1d --- /dev/null +++ b/docs/modules/qmlhc/metrics/qmlhc.metrics.forecasting.rst @@ -0,0 +1,8 @@ +Forecasting Metrics +=================== + +.. automodule:: qmlhc.metrics.forecasting + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/modules/qmlhc/optim/index.rst b/docs/modules/qmlhc/optim/index.rst new file mode 100644 index 0000000..64298b4 --- /dev/null +++ b/docs/modules/qmlhc/optim/index.rst @@ -0,0 +1,12 @@ +Optimization +============ + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Optimization API + diff --git a/docs/modules/qmlhc/optim/qmlhc.optim.api.rst b/docs/modules/qmlhc/optim/qmlhc.optim.api.rst new file mode 100644 index 0000000..1373231 --- /dev/null +++ b/docs/modules/qmlhc/optim/qmlhc.optim.api.rst @@ -0,0 +1,8 @@ +Optimization API +================ + +.. automodule:: qmlhc.optim.api + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/modules/qmlhc/predictors/index.rst b/docs/modules/qmlhc/predictors/index.rst new file mode 100644 index 0000000..9a53a42 --- /dev/null +++ b/docs/modules/qmlhc/predictors/index.rst @@ -0,0 +1,13 @@ +Predictors +========== + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Anticipator — module + Projector — module + diff --git a/docs/modules/qmlhc/predictors/qmlhc.predictors.anticipator.rst b/docs/modules/qmlhc/predictors/qmlhc.predictors.anticipator.rst new file mode 100644 index 0000000..e9dd799 --- /dev/null +++ b/docs/modules/qmlhc/predictors/qmlhc.predictors.anticipator.rst @@ -0,0 +1,8 @@ +Anticipator — module +==================== + +.. automodule:: qmlhc.predictors.anticipator + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/modules/qmlhc/predictors/qmlhc.predictors.projector.rst b/docs/modules/qmlhc/predictors/qmlhc.predictors.projector.rst new file mode 100644 index 0000000..182b6be --- /dev/null +++ b/docs/modules/qmlhc/predictors/qmlhc.predictors.projector.rst @@ -0,0 +1,8 @@ +Projector — module +================== + +.. automodule:: qmlhc.predictors.projector + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/source/modules.rst b/docs/source/modules.rst deleted file mode 100644 index 0788b61..0000000 --- a/docs/source/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -============= - -.. toctree:: - :maxdepth: 4 - - qmlhc diff --git a/docs/source/qmlhc.backends.rst b/docs/source/qmlhc.backends.rst deleted file mode 100644 index da224a9..0000000 --- a/docs/source/qmlhc.backends.rst +++ /dev/null @@ -1,37 +0,0 @@ -qmlhc.backends package -====================== - -Submodules ----------- - -qmlhc.backends.cpp\_backend module ----------------------------------- - -.. automodule:: qmlhc.backends.cpp_backend - :members: - :show-inheritance: - :undoc-members: - -qmlhc.backends.pennylane\_backend module ----------------------------------------- - -.. automodule:: qmlhc.backends.pennylane_backend - :members: - :show-inheritance: - :undoc-members: - -qmlhc.backends.qiskit\_backend module -------------------------------------- - -.. automodule:: qmlhc.backends.qiskit_backend - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: qmlhc.backends - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/qmlhc.callbacks.rst b/docs/source/qmlhc.callbacks.rst deleted file mode 100644 index bc9e382..0000000 --- a/docs/source/qmlhc.callbacks.rst +++ /dev/null @@ -1,37 +0,0 @@ -qmlhc.callbacks package -======================= - -Submodules ----------- - -qmlhc.callbacks.base module ---------------------------- - -.. automodule:: qmlhc.callbacks.base - :members: - :show-inheritance: - :undoc-members: - -qmlhc.callbacks.depth\_control module -------------------------------------- - -.. automodule:: qmlhc.callbacks.depth_control - :members: - :show-inheritance: - :undoc-members: - -qmlhc.callbacks.telemetry module --------------------------------- - -.. automodule:: qmlhc.callbacks.telemetry - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: qmlhc.callbacks - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/qmlhc.core.rst b/docs/source/qmlhc.core.rst deleted file mode 100644 index 1311a16..0000000 --- a/docs/source/qmlhc.core.rst +++ /dev/null @@ -1,45 +0,0 @@ -qmlhc.core package -================== - -Submodules ----------- - -qmlhc.core.backend module -------------------------- - -.. automodule:: qmlhc.core.backend - :members: - :show-inheritance: - :undoc-members: - -qmlhc.core.model module ------------------------ - -.. automodule:: qmlhc.core.model - :members: - :show-inheritance: - :undoc-members: - -qmlhc.core.registry module --------------------------- - -.. automodule:: qmlhc.core.registry - :members: - :show-inheritance: - :undoc-members: - -qmlhc.core.types module ------------------------ - -.. automodule:: qmlhc.core.types - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: qmlhc.core - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/qmlhc.examples.rst b/docs/source/qmlhc.examples.rst deleted file mode 100644 index b7e84ff..0000000 --- a/docs/source/qmlhc.examples.rst +++ /dev/null @@ -1,21 +0,0 @@ -qmlhc.examples package -====================== - -Submodules ----------- - -qmlhc.examples.ex\_minimal\_core\_demo module ---------------------------------------------- - -.. automodule:: qmlhc.examples.ex_minimal_core_demo - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: qmlhc.examples - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/qmlhc.hc.rst b/docs/source/qmlhc.hc.rst deleted file mode 100644 index 9dbacbf..0000000 --- a/docs/source/qmlhc.hc.rst +++ /dev/null @@ -1,37 +0,0 @@ -qmlhc.hc package -================ - -Submodules ----------- - -qmlhc.hc.graph module ---------------------- - -.. automodule:: qmlhc.hc.graph - :members: - :show-inheritance: - :undoc-members: - -qmlhc.hc.node module --------------------- - -.. automodule:: qmlhc.hc.node - :members: - :show-inheritance: - :undoc-members: - -qmlhc.hc.policy module ----------------------- - -.. automodule:: qmlhc.hc.policy - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: qmlhc.hc - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/qmlhc.loss.rst b/docs/source/qmlhc.loss.rst deleted file mode 100644 index 869b4d4..0000000 --- a/docs/source/qmlhc.loss.rst +++ /dev/null @@ -1,37 +0,0 @@ -qmlhc.loss package -================== - -Submodules ----------- - -qmlhc.loss.coherence module ---------------------------- - -.. automodule:: qmlhc.loss.coherence - :members: - :show-inheritance: - :undoc-members: - -qmlhc.loss.consistency module ------------------------------ - -.. automodule:: qmlhc.loss.consistency - :members: - :show-inheritance: - :undoc-members: - -qmlhc.loss.task module ----------------------- - -.. automodule:: qmlhc.loss.task - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: qmlhc.loss - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/qmlhc.metrics.rst b/docs/source/qmlhc.metrics.rst deleted file mode 100644 index 0b8aee2..0000000 --- a/docs/source/qmlhc.metrics.rst +++ /dev/null @@ -1,37 +0,0 @@ -qmlhc.metrics package -===================== - -Submodules ----------- - -qmlhc.metrics.anomalies module ------------------------------- - -.. automodule:: qmlhc.metrics.anomalies - :members: - :show-inheritance: - :undoc-members: - -qmlhc.metrics.control module ----------------------------- - -.. automodule:: qmlhc.metrics.control - :members: - :show-inheritance: - :undoc-members: - -qmlhc.metrics.forecasting module --------------------------------- - -.. automodule:: qmlhc.metrics.forecasting - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: qmlhc.metrics - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/qmlhc.optim.rst b/docs/source/qmlhc.optim.rst deleted file mode 100644 index 01df5ad..0000000 --- a/docs/source/qmlhc.optim.rst +++ /dev/null @@ -1,21 +0,0 @@ -qmlhc.optim package -=================== - -Submodules ----------- - -qmlhc.optim.api module ----------------------- - -.. automodule:: qmlhc.optim.api - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: qmlhc.optim - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/qmlhc.predictors.rst b/docs/source/qmlhc.predictors.rst deleted file mode 100644 index 83d3fdf..0000000 --- a/docs/source/qmlhc.predictors.rst +++ /dev/null @@ -1,29 +0,0 @@ -qmlhc.predictors package -======================== - -Submodules ----------- - -qmlhc.predictors.anticipator module ------------------------------------ - -.. automodule:: qmlhc.predictors.anticipator - :members: - :show-inheritance: - :undoc-members: - -qmlhc.predictors.projector module ---------------------------------- - -.. automodule:: qmlhc.predictors.projector - :members: - :show-inheritance: - :undoc-members: - -Module contents ---------------- - -.. automodule:: qmlhc.predictors - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/source/qmlhc.rst b/docs/source/qmlhc.rst deleted file mode 100644 index 4068301..0000000 --- a/docs/source/qmlhc.rst +++ /dev/null @@ -1,26 +0,0 @@ -qmlhc package -============= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - qmlhc.backends - qmlhc.callbacks - qmlhc.core - qmlhc.examples - qmlhc.hc - qmlhc.loss - qmlhc.metrics - qmlhc.optim - qmlhc.predictors - -Module contents ---------------- - -.. automodule:: qmlhc - :members: - :show-inheritance: - :undoc-members: diff --git a/docs/theory.rst b/docs/theory.rst new file mode 100644 index 0000000..23e4552 --- /dev/null +++ b/docs/theory.rst @@ -0,0 +1,12 @@ +Theory / Concepts +================= + +This section explains the theoretical foundations of QML-HCS, covering +quantum principles, causal inference, and the mathematics behind hybrid learning. + + + +.. warning:: + + 🚧 These sections are currently under active development. + Content will be expanded soon with detailed explanations, diagrams, and examples.