Skip to content

Commit 36e281d

Browse files
HectorMozo3110HectorMozo3110
authored
Merge pull request #8 from HectorMozo3110/main
docs: add new documentation sections and mark them as under development
2 parents 5c0d3ec + 712101c commit 36e281d

53 files changed

Lines changed: 409 additions & 339 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/architecture.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Architecture
2+
============
3+
4+
This section describes the internal design of QML-HCS, including its modular
5+
quantum-classical architecture and interaction between core components.
6+
7+
8+
.. warning::
9+
10+
🚧 These sections are currently under active development.
11+
Content will be expanded soon with detailed explanations, diagrams, and examples.

‎docs/benchmarks.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Benchmarks / Performance
2+
========================
3+
4+
This section presents benchmark results comparing QML-HCS to classical
5+
machine learning models, highlighting speed, efficiency, and scalability.
6+
7+
8+
.. warning::
9+
10+
🚧 These sections are currently under active development.
11+
Content will be expanded soon with detailed explanations, diagrams, and examples.

‎docs/changelog.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Changelog / Versioning
2+
======================
3+
4+
Version history and updates for QML-HCS.
5+
6+
.. warning::
7+
8+
🚧 These sections are currently under active development.
9+
Content will be expanded soon with detailed explanations, diagrams, and examples.

‎docs/examples.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _examples:
22

3-
Examples
4-
========
3+
Quickstart / Tutorials
4+
======================
55

66
This section contains independent runnable examples of the QML-HCS system.
77
Each link below opens a separate page with the full documentation of that example.

‎docs/getting_started.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _getting_started:
22

3-
Getting Started
4-
===============
3+
Installation
4+
============
55

66
This section guides you through installing, configuring, and verifying **QML-HCS** —
77
the *Quantum Machine Learning Hypercausal System*.

‎docs/index.rst‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,19 @@ Welcome. Explore the examples, modules, and benchmark studies to understand how
4242
:caption: Contents
4343
:hidden:
4444

45+
Overview <self>
4546
getting_started
4647
examples
48+
architecture
49+
theory
50+
integration
51+
benchmarks
52+
changelog
4753
contributing
48-
source/modules
54+
modules/api_overview
4955
GitHub Repository <https://github.com/Neureonmindflux-Research-Lab/qml-hcs>
5056

5157

5258

5359

60+

‎docs/integration.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Integration
2+
===========
3+
4+
This section shows how QML-HCS integrates with external frameworks such as
5+
Qiskit, PennyLane, and PyTorch for hybrid workflows.
6+
7+
8+
.. warning::
9+
10+
🚧 These sections are currently under active development.
11+
Content will be expanded soon with detailed explanations, diagrams, and examples.

‎docs/modules/api_overview.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
API Overview
2+
============
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
:titlesonly:
7+
8+
Backends <qmlhc/backends/index>
9+
Callbacks <qmlhc/callbacks/index>
10+
Core Engine <qmlhc/core/index>
11+
Examples <qmlhc/examples/index>
12+
Hypercausal Graph <qmlhc/hc/index>
13+
Loss Functions <qmlhc/loss/index>
14+
Metrics <qmlhc/metrics/index>
15+
Optimization <qmlhc/optim/index>
16+
Predictors <qmlhc/predictors/index>
17+

‎docs/modules/qmlhc/backends/index.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Backends
2+
========
3+
4+
Submodules
5+
----------
6+
7+
.. toctree::
8+
:maxdepth: 1
9+
:titlesonly:
10+
11+
C++ Backend (pybind11) <qmlhc.backends.cpp_backend>
12+
PennyLane Backend <qmlhc.backends.pennylane_backend>
13+
Qiskit Backend <qmlhc.backends.qiskit_backend>
14+

‎docs/modules/qmlhc/backends/qmlhc.backends.cpp_backend.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
C++ Backend (pybind11)
2+
======================
3+
4+
.. automodule:: qmlhc.backends.cpp_backend
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+

0 commit comments

Comments
 (0)