thek0tyara/llama-cpp-turboquant
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Updated documentaion to include python

Browse source
This commit is contained in:
Alejandro Saucedo 2020-11-02 21:47:05 +00:00
parent 02406d46ca
commit 159504f20f
3 changed files with 51 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/conf.py
View file

@ -16,6 +16,9 @@
# -- Project information -----------------------------------------------------
import sys
import os
import komputepy
project = 'Vulkan Kompute'
copyright = '2020, The Institute for Ethical AI & Machine Learning'
@ -31,6 +34,7 @@ release = '0.4.0'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
# Creates .nojekyll config
'sphinx.ext.githubpages',
# Integrates with doxygen

5
docs/index.rst
View file

@ -11,13 +11,14 @@ Index
:maxdepth: 2
:titlesonly:
Class Documentation and C++ Reference <overview/reference>
Advanced Examples <overview/advanced-examples>
Simple & Advanced Examples <overview/advanced-examples>
Asynchronous & Parallel Operations <overview/async-parallel>
Memory Management Principles <overview/memory-management>
Build System Deep Dive <overview/build-system>
Converting GLSL/HLSL Shaders to C++ Headers <overview/shaders-to-headers>
Mobile App Integration (Android) <overview/mobile-android>
Game Engine Integration (Godot Engine) <overview/game-engine-godot>
Python Class Documentation & Reference <overview/python-package>
C++ Class Documentation & Reference <overview/reference>
Code Index <genindex>

44
docs/overview/python-package.rst Normal file
View file

@ -0,0 +1,44 @@
Python Class Documentation & Reference
========
This section provides a breakdown of the Python classes and what each of their functions provide.
Below is a diagram that provides insights on the relationship between Vulkan Kompute objects and Vulkan resources, which primarily encompass ownership of either CPU and/or GPU memory.
.. image:: ../images/kompute-architecture.jpg
:width: 70%
Manager
-------
The Kompute Manager provides a high level interface to simplify interaction with underlying :class:`komputepy.Sequence` of Operations.
.. autoclass:: komputepy.Manager
:members:
Sequence
-------
The Kompute Sequence consists of batches of Kompute Operations, which are executed on a respective GPU queue. The execution of sequences can be synchronous or asynchronous, and it can be coordinated through its respective Vulkan Fence.
.. autoclass:: komputepy.Sequence
:members:
Tensor
-------
The Kompute Tensor is the atomic unit in Kompute, and it is used primarily for handling Host and GPU Device data.
.. autoclass:: komputepy.Tensor
:members:
TensorType
-------
.. automodule:: komputepy
:members: