+
+A GPGPU (General Purpose GPU) processing framework to augment your Vulkan Compute experience.
+
## Principles
-* Single header easy to import library to boost your Vulkan compute experience (WIP)
-* Non-vulkan naming convention to disambiguate Vulkan vs Kompute components
-* Extends the existing vulkan API with a simpler compute-specific interface
+* Single header easy to import static library
+* 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
* BYOV: Play nice with existing Vulkan applications with a bring-your-own-Vulkan design
-* TODO
+* Directed acyclic memory management and relationships of ownership
+* Explicit memory management responsibilities
+* Opinionated approach towards base interface for memory management hierarchy with explicit and extensible design
+* Best practices for safe memory GPU / Vulkan memory management (WIP)
+
+## Motivations
+
+Vulkan Kompute was created after identifying the challenge most GPU processing projects with Vulkan undergo - namely having to build extensive boilerplate for Vulkan and create abstractions and interfaces that expose the core compute capabilities. It is only after a few thousand lines of code that it's possible to start building the application-specific logic.
+
+We believe Vulkan has an excellent design in its way to interact with the GPU, so by no means we aim to abstract or hide any complexity, but instead we want to provide a baseline of tools and interfaces that allow Vulkan Compute developers to focus on the higher level computational complexities of the application.
+
+It is because of this that we have adopted development principles for the project that ensure the Vulkan API is augmented specifically for computation, whilst speeding development iterations and opening the doors to further use-cases.
## Getting Started
-Run your tensors against default or custom equations via the Manager.
+Run your tensors against default operations via the Manager.
```c++
int main() {
@@ -33,7 +63,7 @@ int main() {
}
```
-Record commands in a single submit by using a Sequence.
+Record commands in a single submit by using a Sequence to send in batch to GPU.
```c++
int main() {
@@ -64,7 +94,7 @@ int main() {
}
```
-Create your own operation
+Create your own custom operations to leverage Vulkan Compute for your specialised use-cases.
```c++
class CustomOp : kp::OpBase {
@@ -89,12 +119,58 @@ int main() {
}
```
+## Components & Architecture
+
+The core architecture of Kompute include the following:
+* Kompute Manager - Base orchestrator which creates and manages device and child components
+* Kompute Sequence - Container of operations that can be sent to GPU as batch
+* Kompute Operation - Individual operation which performs actions on top of tensors and (opt) algorithms
+* Kompute Tensor - Tensor structured data used in GPU operations
+* Kompute Algorithm - Abstraction for (shader) code executed in the GPU
+* Kompute ParameterGroup - Container that can group tensors to be fed into an algorithm
+
+To see a full breakdown you can read further in the documentation.
+
+
+
+Full Vulkan Components
+
+
+Simplified Kompute Components
+
+
+
+
+
+
+
+
+
+(very tiny, check the docs to for details)
+
+
+
+
+
+
+
+
+
+
+
+
## Kompute Development
+We appreciate PRs and Issues. If you want to contribute try checking the "Good first issue" tag, but even using Vulkan Kompute and reporting issues is a great contribution!
+
+### Dev Overview
+
* Follows Mozilla C++ Style Guide https://www-archive.mozilla.org/hacking/mozilla-style-guide.html
+ Uses post-commit hook to run the linter, you can set it up so it runs the linter before commit
* Uses vcpkg for finding the dependencies, it's the recommanded set up to retrieve the libraries
+ All dependencies are defined in vcpkg.json
* Uses cmake as build system, and provides a top level makefile with recommended command
* Uses xxd (or xxd.exe windows 64bit port) to convert shader spirv to header files
+
+
diff --git a/docs/images/kompute-architecture.jpg b/docs/images/kompute-architecture.jpg
new file mode 100755
index 000000000..4dc763bdf
Binary files /dev/null and b/docs/images/kompute-architecture.jpg differ
diff --git a/docs/images/kompute-vulkan-architecture.jpg b/docs/images/kompute-vulkan-architecture.jpg
new file mode 100755
index 000000000..c520f70af
Binary files /dev/null and b/docs/images/kompute-vulkan-architecture.jpg differ
diff --git a/docs/images/kompute.jpg b/docs/images/kompute.jpg
new file mode 100755
index 000000000..e34ac98b0
Binary files /dev/null and b/docs/images/kompute.jpg differ
+
+
+
+
+
+