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

Updated docs for naming

Browse source
This commit is contained in:
Alejandro Saucedo 2021-05-11 09:46:57 +01:00
parent a3db6acd5d
commit 0788ec875f
9 changed files with 29 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/overview/custom-operations.rst
View file

@ -13,7 +13,7 @@ Flow of Function Calls
The top level operation which all operations inherit from is the :class:`kp::OpBase` class. Some of the "Core Native Operations" like :class:`kp::OpTensorCopy`, :class:`kp::OpTensorCreate`, etc all inherit from the base operation class.
The `kp::OpAlgoBase` is another base operation that is specifically built to enable users to create their own operations that contain custom shader logic (i.e. requiring Vulkan Compute Pipelines, DescriptorSets, etc). The next section contains an example which shows how to extend the OpAlgoBase class.
The `kp::OpAlgoBase` is another base operation that is specifically built to enable users to create their own operations that contain custom shader logic (i.e. requiring Compute Pipelines, DescriptorSets, etc). The next section contains an example which shows how to extend the OpAlgoBase class.
Below you
@ -25,11 +25,11 @@ Below you
* - OpBase(..., tensors, freeTensors)
- Constructor for class where you can load/define resources such as shaders, etc.
* - ~OpBase()
- Destructor that frees vulkan resources (if owned) which should be used to manage any memory allocations created through the operation.
- Destructor that frees GPU resources (if owned) which should be used to manage any memory allocations created through the operation.
* - init()
- Init function gets called in the Sequence / Manager inside the record step. This function allows for relevant objects to be initialised within the operation.
* - record()
- Record function that gets called in the Sequence / Manager inside the record step after init(). In this function you can directly record to the Vulkan command buffer.
- Record function that gets called in the Sequence / Manager inside the record step after init(). In this function you can directly record to the vk::CommandBuffer.
* - preEval()
- When the Sequence is Evaluated this preEval is called across all operations before dispatching the batch of recorded commands to the GPU. This is useful for example if you need to copy data from local to host memory.
* - postEval()