diff --git a/README.md b/README.md index 75ee6ed0f..9f3bfc531 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,13 @@ -🔋 [Documentation]() 💻 [Import to your project]() ⌨ [Tutorials]() 💾 +🔋 [Documentation](https://axsaucedo.github.io/vulkan-kompute/) 💻 [Import to your project](https://axsaucedo.github.io/vulkan-kompute/) ⌨ [Tutorials](https://axsaucedo.github.io/vulkan-kompute/) 💾 ## Principles & Features * Single header easy to import static library -* [Documentation]() using doxygen and sphinx for +* [Documentation](https://axsaucedo.github.io/vulkan-kompute/) using doxygen and sphinx for * Packaged with vcpkg for easy download and integration with projects * Non-Vulkan naming convention to disambiguate Vulkan vs Kompute components * Extends the existing Vulkan API with a compute-specific interface diff --git a/docs/images/kompute-vulkan-architecture-algorithm.jpg b/docs/images/kompute-vulkan-architecture-algorithm.jpg new file mode 100755 index 000000000..9ca373aed Binary files /dev/null and b/docs/images/kompute-vulkan-architecture-algorithm.jpg differ diff --git a/docs/images/kompute-vulkan-architecture-manager.jpg b/docs/images/kompute-vulkan-architecture-manager.jpg new file mode 100755 index 000000000..707eb71d6 Binary files /dev/null and b/docs/images/kompute-vulkan-architecture-manager.jpg differ diff --git a/docs/images/kompute-vulkan-architecture-opcreatetensor.jpg b/docs/images/kompute-vulkan-architecture-opcreatetensor.jpg new file mode 100755 index 000000000..fa26a7dff Binary files /dev/null and b/docs/images/kompute-vulkan-architecture-opcreatetensor.jpg differ diff --git a/docs/images/kompute-vulkan-architecture-operations.jpg b/docs/images/kompute-vulkan-architecture-operations.jpg new file mode 100755 index 000000000..25c8633dd Binary files /dev/null and b/docs/images/kompute-vulkan-architecture-operations.jpg differ diff --git a/docs/images/kompute-vulkan-architecture-opmult.jpg b/docs/images/kompute-vulkan-architecture-opmult.jpg new file mode 100755 index 000000000..6236a9603 Binary files /dev/null and b/docs/images/kompute-vulkan-architecture-opmult.jpg differ diff --git a/docs/images/kompute-vulkan-architecture-sequence.jpg b/docs/images/kompute-vulkan-architecture-sequence.jpg new file mode 100755 index 000000000..d48d90d7e Binary files /dev/null and b/docs/images/kompute-vulkan-architecture-sequence.jpg differ diff --git a/docs/images/kompute-vulkan-architecture-tensor.jpg b/docs/images/kompute-vulkan-architecture-tensor.jpg new file mode 100755 index 000000000..0be913b7e Binary files /dev/null and b/docs/images/kompute-vulkan-architecture-tensor.jpg differ diff --git a/docs/index.rst b/docs/index.rst index 2f7c8543e..03832a4b3 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,45 +14,78 @@ Welcome to Vulkan Kompute's documentation! Reference -==== +======== You can also go directoy to the `raw doxygen docs `_ +Overview of entire dependencies and their relationship with vulkan component ownership. + +.. image:: images/kompute-vulkan-architecture.jpg + :width: 100% + Manager ------- .. doxygenclass:: kp::Manager :members: +.. image:: images/kompute-vulkan-architecture-manager.jpg + :width: 100% + Sequence ------- .. doxygenclass:: kp::Sequence :members: +.. image:: images/kompute-vulkan-architecture-sequence.jpg + :width: 100% + +Tensor +------- + +.. doxygenclass:: kp::Tensor + :members: + +.. image:: images/kompute-vulkan-architecture-tensor.jpg + :width: 100% + +Algorithm +------- + +.. doxygenclass:: kp::Algorithm + :members: + +.. image:: images/kompute-vulkan-architecture-algorithm.jpg + :width: 100% + OpBase ------- .. doxygenclass:: kp::OpBase :members: +.. image:: images/kompute-vulkan-architecture-operations.jpg + :width: 100% + OpMult ------- .. doxygenclass:: kp::OpMult :members: +.. image:: images/kompute-vulkan-architecture-opmult.jpg + :width: 100% + OpCreateTensor ------- .. doxygenclass:: kp::OpCreateTensor :members: -Algorithm -------- +.. image:: images/kompute-vulkan-architecture-opcreatetensor.jpg + :width: 100% -.. doxygenclass:: kp::Algorithm - :members: Indices and tables