Updated the documentation to specify the components that are memory owned

src/include/kompute/Algorithm.hpp

@@ -50,16 +50,15 @@ class Algorithm
     void recordDispatch(uint32_t x = 1, uint32_t y = 1, uint32_t z = 1);
 
   private:
-    // Never Owned Resources
+    // -------------- NEVER OWNED RESOURCES
     std::shared_ptr<vk::Device> mDevice;
     std::shared_ptr<vk::CommandBuffer> mCommandBuffer;
 
-    // Optionally owned resources
+    // -------------- OPTIONALLY OWNED RESOURCES
     std::shared_ptr<vk::DescriptorSetLayout> mDescriptorSetLayout;
     bool mFreeDescriptorSetLayout = false;
     std::shared_ptr<vk::DescriptorPool> mDescriptorPool;
     bool mFreeDescriptorPool = false;
-
     // TODO: Explore design for multiple descriptor sets
     std::shared_ptr<vk::DescriptorSet> mDescriptorSet;
     bool mFreeDescriptorSet = false;

src/include/kompute/Manager.hpp

@@ -84,6 +84,7 @@ class Manager
     }
 
   private:
+    // -------------- OPTIONALLY OWNED RESOURCES
     std::shared_ptr<vk::Instance> mInstance = nullptr;
     bool mFreeInstance = false;
     std::shared_ptr<vk::PhysicalDevice> mPhysicalDevice = nullptr;
@@ -93,7 +94,7 @@ class Manager
     uint32_t mComputeQueueFamilyIndex = -1;
     std::shared_ptr<vk::Queue> mComputeQueue = nullptr;
 
-    // Always owned resources
+    // -------------- ALWAYS OWNED RESOURCES
     std::unordered_map<std::string, std::shared_ptr<Sequence>>
       mManagedSequences;
 

src/include/kompute/Parameter.hpp

@@ -21,10 +21,10 @@ class Algorithm
     ~Algorithm();
 
   private:
-    // Shared resources
+    // -------------- NEVER OWNED RESOURCES
     std::shared_ptr<vk::Device> mDevice;
 
-    // Resources owned by default
+    // -------------- OPTIONALLY OWNED RESOURCES
     std::shared_ptr<vk::DescriptorSetLayout> mDescriptorSetLayout;
     bool mFreeDescriptorSetLayout = false;
     std::shared_ptr<vk::DescriptorPool> mDescriptorPool;

src/include/kompute/Sequence.hpp

@@ -104,10 +104,13 @@ class Sequence
     }
 
   private:
+    // -------------- NEVER OWNED RESOURCES
     std::shared_ptr<vk::PhysicalDevice> mPhysicalDevice = nullptr;
     std::shared_ptr<vk::Device> mDevice = nullptr;
     std::shared_ptr<vk::Queue> mComputeQueue = nullptr;
     uint32_t mQueueIndex = -1;
+
+    // -------------- OPTIONALLY OWNED RESOURCES
     std::shared_ptr<vk::CommandPool> mCommandPool = nullptr;
     bool mFreeCommandPool = false;
     std::shared_ptr<vk::CommandBuffer> mCommandBuffer = nullptr;

src/include/kompute/Tensor.hpp

@@ -132,15 +132,18 @@ class Tensor
     void mapDataIntoHostMemory();
 
   private:
+    // -------------- NEVER OWNED RESOURCES
     std::shared_ptr<vk::PhysicalDevice> mPhysicalDevice;
     std::shared_ptr<vk::Device> mDevice;
     std::shared_ptr<vk::CommandBuffer> mCommandBuffer;
 
+    // -------------- OPTIONALLY OWNED RESOURCES
     std::shared_ptr<vk::Buffer> mBuffer;
     bool mFreeBuffer;
     std::shared_ptr<vk::DeviceMemory> mMemory;
     bool mFreeMemory;
 
+    // -------------- ALWAYS OWNED RESOURCES
     std::vector<uint32_t> mData;
 
     TensorTypes mTensorType = TensorTypes::eDevice;
@@ -148,8 +151,7 @@ class Tensor
     std::array<uint32_t, KP_MAX_DIM_SIZE> mShape;
     bool mIsInit = false;
 
-    // Creates the vulkan buffer
-    void createBuffer();
+    void createBuffer(); // Creates the vulkan buffer
 
     // Private util functions
     vk::BufferUsageFlags getBufferUsageFlags();

src/include/kompute/operations/OpBase.hpp

@@ -96,19 +96,19 @@ class OpBase
     virtual void postSubmit() = 0;
 
   protected:
-    // OPTIONALLY OWNED RESOURCES
-    std::vector<std::shared_ptr<Tensor>>
-      mTensors; ///< Tensors referenced by operation that can be managed
-                ///< optionally by operation
-    bool mFreeTensors = false; ///< Explicit boolean that specifies whether the
-                               ///< tensors are freed (if they are managed)
-
-    // NEVER OWNED RESOURCES
+    // -------------- NEVER OWNED RESOURCES
     std::shared_ptr<vk::PhysicalDevice>
       mPhysicalDevice;                   ///< Vulkan Physical Device
     std::shared_ptr<vk::Device> mDevice; ///< Vulkan Logical Device
     std::shared_ptr<vk::CommandBuffer>
       mCommandBuffer; ///< Vulkan Command Buffer
+
+    // -------------- OPTIONALLY OWNED RESOURCES
+    std::vector<std::shared_ptr<Tensor>>
+      mTensors; ///< Tensors referenced by operation that can be managed
+                ///< optionally by operation
+    bool mFreeTensors = false; ///< Explicit boolean that specifies whether the
+                               ///< tensors are freed (if they are managed)
 };
 
 } // End namespace kp

src/include/kompute/operations/OpMult.hpp

@@ -77,18 +77,18 @@ class OpMult : public OpBase
     void postSubmit() override;
 
   private:
-    // Always owned resources
-    std::shared_ptr<Tensor> mTensorOutputStaging;
-
-    // Optionally owned resources
-    std::shared_ptr<Algorithm> mAlgorithm;
-    bool mFreeAlgorithm = false;
-
-    // Never owned resources
+    // -------------- NEVER OWNED RESOURCES
     std::shared_ptr<Tensor> mTensorLHS;
     std::shared_ptr<Tensor> mTensorRHS;
     std::shared_ptr<Tensor> mTensorOutput;
 
+    // -------------- OPTIONALLY OWNED RESOURCES
+    std::shared_ptr<Algorithm> mAlgorithm;
+    bool mFreeAlgorithm = false;
+
+    // -------------- ALWAYS OWNED RESOURCES
+    std::shared_ptr<Tensor> mTensorOutputStaging;
+
     uint32_t mX;
     uint32_t mY;
     uint32_t mZ;