Updated added images for diagram
|
|
@ -22,13 +22,13 @@
|
|||
</tr>
|
||||
</table>
|
||||
|
||||
🔋 [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
|
||||
|
|
|
|||
BIN
docs/images/kompute-vulkan-architecture-algorithm.jpg
Executable file
|
After Width: | Height: | Size: 52 KiB |
BIN
docs/images/kompute-vulkan-architecture-manager.jpg
Executable file
|
After Width: | Height: | Size: 47 KiB |
BIN
docs/images/kompute-vulkan-architecture-opcreatetensor.jpg
Executable file
|
After Width: | Height: | Size: 44 KiB |
BIN
docs/images/kompute-vulkan-architecture-operations.jpg
Executable file
|
After Width: | Height: | Size: 90 KiB |
BIN
docs/images/kompute-vulkan-architecture-opmult.jpg
Executable file
|
After Width: | Height: | Size: 47 KiB |
BIN
docs/images/kompute-vulkan-architecture-sequence.jpg
Executable file
|
After Width: | Height: | Size: 36 KiB |
BIN
docs/images/kompute-vulkan-architecture-tensor.jpg
Executable file
|
After Width: | Height: | Size: 44 KiB |
|
|
@ -14,45 +14,78 @@ Welcome to Vulkan Kompute's documentation!
|
|||
|
||||
|
||||
Reference
|
||||
====
|
||||
========
|
||||
|
||||
You can also go directoy to the `raw doxygen docs <doxygen/annotated.html>`_
|
||||
|
||||
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
|
||||
|
|
|
|||