#include <Manager.hpp>

Public Member Functions
	Manager ()

	Manager (uint32_t physicalDeviceIndex, const std::vector< uint32_t > &familyQueueIndices={}, const std::vector< std::string > &desiredExtensions={})

	Manager (std::shared_ptr< vk::Instance > instance, std::shared_ptr< vk::PhysicalDevice > physicalDevice, std::shared_ptr< vk::Device > device)

	Manager (const Manager &)=delete
	Make Manager uncopyable.

	Manager (const Manager &&)=delete

Manager &	operator= (const Manager &)=delete

Manager &	operator= (const Manager &&)=delete

	~Manager ()

std::shared_ptr< Sequence >	sequence (uint32_t queueIndex=0, uint32_t totalTimestamps=0)

template<typename T >
std::shared_ptr< TensorT< T > >	tensorT (const std::vector< T > &data, Memory::MemoryTypes tensorType=Memory::MemoryTypes::eDevice)

template<typename T >
std::shared_ptr< TensorT< T > >	tensorT (size_t size, Memory::MemoryTypes tensorType=Memory::MemoryTypes::eDevice)

std::shared_ptr< TensorT< float > >	tensor (const std::vector< float > &data, Memory::MemoryTypes tensorType=Memory::MemoryTypes::eDevice)

std::shared_ptr< Tensor >	tensor (void *data, uint32_t elementTotalCount, uint32_t elementMemorySize, const Memory::DataTypes &dataType, Memory::MemoryTypes tensorType=Memory::MemoryTypes::eDevice)

std::shared_ptr< Tensor >	tensor (uint32_t elementTotalCount, uint32_t elementMemorySize, const Memory::DataTypes &dataType, Memory::MemoryTypes tensorType=Memory::MemoryTypes::eDevice)

template<typename T >
std::shared_ptr< ImageT< T > >	imageT (const std::vector< T > &data, uint32_t width, uint32_t height, uint32_t numChannels, vk::ImageTiling tiling, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

template<typename T >
std::shared_ptr< ImageT< T > >	imageT (const std::vector< T > &data, uint32_t width, uint32_t height, uint32_t numChannels, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

template<typename T >
std::shared_ptr< ImageT< T > >	imageT (uint32_t width, uint32_t height, uint32_t numChannels, vk::ImageTiling tiling, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

template<typename T >
std::shared_ptr< ImageT< T > >	imageT (uint32_t width, uint32_t height, uint32_t numChannels, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

std::shared_ptr< ImageT< float > >	image (const std::vector< float > &data, uint32_t width, uint32_t height, uint32_t numChannels, vk::ImageTiling tiling, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

std::shared_ptr< ImageT< float > >	image (const std::vector< float > &data, uint32_t width, uint32_t height, uint32_t numChannels, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

std::shared_ptr< ImageT< float > >	image (uint32_t width, uint32_t height, uint32_t numChannels, vk::ImageTiling tiling, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

std::shared_ptr< ImageT< float > >	image (uint32_t width, uint32_t height, uint32_t numChannels, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

std::shared_ptr< Image >	image (void *data, size_t dataSize, uint32_t width, uint32_t height, uint32_t numChannels, const Image::DataTypes &dataType, vk::ImageTiling tiling, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

std::shared_ptr< Image >	image (void *data, size_t dataSize, uint32_t width, uint32_t height, uint32_t numChannels, const Memory::DataTypes &dataType, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

std::shared_ptr< Image >	image (uint32_t width, uint32_t height, uint32_t numChannels, const Memory::DataTypes &dataType, vk::ImageTiling tiling, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

std::shared_ptr< Image >	image (uint32_t width, uint32_t height, uint32_t numChannels, const Memory::DataTypes &dataType, Memory::MemoryTypes imageType=Memory::MemoryTypes::eDevice)

std::shared_ptr< Algorithm >	algorithm (const std::vector< std::shared_ptr< Memory > > &memObjects={}, const std::vector< uint32_t > &spirv={}, const Workgroup &workgroup={}, const std::vector< float > &specializationConstants={}, const std::vector< float > &pushConstants={})

template<typename S = float, typename P = float>
std::shared_ptr< Algorithm >	algorithm (const std::vector< std::shared_ptr< Memory > > &memObjects, const std::vector< uint32_t > &spirv, const Workgroup &workgroup, const std::vector< S > &specializationConstants, const std::vector< P > &pushConstants)

void	destroy ()

void	clear ()

vk::PhysicalDeviceProperties	getDeviceProperties () const

std::vector< vk::PhysicalDevice >	listDevices () const

std::shared_ptr< vk::Instance >	getVkInstance () const

Detailed Description

Base orchestrator which creates and manages device and child components

Constructor & Destructor Documentation

◆ Manager() [1/3]

kp::Manager::Manager ( )

Base constructor and default used which creates the base resources including choosing the device 0 by default.

◆ Manager() [2/3]

kp::Manager::Manager	(	uint32_t	physicalDeviceIndex,
		const std::vector< uint32_t > &	familyQueueIndices = `{}`,
		const std::vector< std::string > &	desiredExtensions = `{}`
	)

Similar to base constructor but allows for further configuration to use when creating the Vulkan resources.

Parameters

physicalDeviceIndex	The index of the physical device to use
familyQueueIndices	(Optional) List of queue indices to add for explicit allocation
desiredExtensions	The desired extensions to load from physicalDevice

◆ Manager() [3/3]

kp::Manager::Manager	(	std::shared_ptr< vk::Instance >	instance,
		std::shared_ptr< vk::PhysicalDevice >	physicalDevice,
		std::shared_ptr< vk::Device >	device
	)

Manager constructor which allows your own vulkan application to integrate with the kompute use.

Parameters

instance	Vulkan compute instance to base this application
physicalDevice	Vulkan physical device to use for application
device	Vulkan logical device to use for all base resources
physicalDeviceIndex	Index for vulkan physical device used

◆ ~Manager()

kp::Manager::~Manager ( )

Manager destructor which would ensure all owned resources are destroyed unless explicitly stated that resources should not be destroyed or freed.

Member Function Documentation

◆ algorithm() [1/2]

template<typename S = float, typename P = float>

std::shared_ptr< Algorithm > kp::Manager::algorithm	(	const std::vector< std::shared_ptr< Memory > > &	memObjects,
		const std::vector< uint32_t > &	spirv,
		const Workgroup &	workgroup,
		const std::vector< S > &	specializationConstants,
		const std::vector< P > &	pushConstants
	)

inline

Create a managed algorithm that will be destroyed by this manager if it hasn't been destroyed by its reference count going to zero.

Parameters

memObjects	(optional) The mem objects to initialise the algorithm with
spirv	(optional) The SPIRV bytes for the algorithm to dispatch
workgroup	(optional) kp::Workgroup for algorithm to use, and defaults to (tensor[0].size(), 1, 1)
specializationConstants	(optional) templatable vector parameter to use for specialization constants, and defaults to an empty constant
pushConstants	(optional) templatable vector parameter to use for push constants, and defaults to an empty constant

Returns: Shared pointer with initialised algorithm

◆ algorithm() [2/2]

std::shared_ptr< Algorithm > kp::Manager::algorithm	(	const std::vector< std::shared_ptr< Memory > > &	memObjects = `{}`,
		const std::vector< uint32_t > &	spirv = `{}`,
		const Workgroup &	workgroup = `{}`,
		const std::vector< float > &	specializationConstants = `{}`,
		const std::vector< float > &	pushConstants = `{}`
	)

inline

Default non-template function that can be used to create algorithm objects which provides default types to the push and spec constants as floats.

Parameters

memObjects	(optional) The mem objects to initialise the algorithm with
spirv	(optional) The SPIRV bytes for the algorithm to dispatch
workgroup	(optional) kp::Workgroup for algorithm to use, and defaults to (tensor[0].size(), 1, 1)
specializationConstants	(optional) float vector to use for specialization constants, and defaults to an empty constant
pushConstants	(optional) float vector to use for push constants, and defaults to an empty constant

Returns: Shared pointer with initialised algorithm

◆ clear()

void kp::Manager::clear ( )

Run a pseudo-garbage collection to release all the managed resources that have been already freed due to these reaching to zero ref count.

◆ destroy()

void kp::Manager::destroy ( )

Destroy the GPU resources and all managed resources by manager.

◆ getDeviceProperties()

vk::PhysicalDeviceProperties kp::Manager::getDeviceProperties ( ) const

Information about the current device.

Returns: vk::PhysicalDeviceProperties containing information about the device

◆ getVkInstance()

std::shared_ptr< vk::Instance > kp::Manager::getVkInstance ( ) const

The current Vulkan instance.

Returns: a shared pointer to the current Vulkan instance held by this object

◆ imageT()

template<typename T >

std::shared_ptr< ImageT< T > > kp::Manager::imageT	(	const std::vector< T > &	data,
		uint32_t	width,
		uint32_t	height,
		uint32_t	numChannels,
		vk::ImageTiling	tiling,
		Memory::MemoryTypes	imageType = `Memory::MemoryTypes::eDevice`
	)

inline

Create a managed image that will be destroyed by this manager if it hasn't been destroyed by its reference count going to zero.

Parameters

data	The data to initialize the image with
tensorType	The type of image to initialize

Returns: Shared pointer with initialised image

◆ listDevices()

std::vector< vk::PhysicalDevice > kp::Manager::listDevices ( ) const

List the devices available in the current vulkan instance.

Returns: vector of physical devices containing their respective properties

◆ sequence()

std::shared_ptr< Sequence > kp::Manager::sequence	(	uint32_t	queueIndex = `0`,
		uint32_t	totalTimestamps = `0`
	)

Create a managed sequence that will be destroyed by this manager if it hasn't been destroyed by its reference count going to zero.

Parameters

queueIndex	The queue to use from the available queues
nrOfTimestamps	The maximum number of timestamps to allocate. If zero (default), disables latching of timestamps.

Returns: Shared pointer with initialised sequence

◆ tensorT() [1/2]

template<typename T >

std::shared_ptr< TensorT< T > > kp::Manager::tensorT	(	const std::vector< T > &	data,
		Memory::MemoryTypes	tensorType = `Memory::MemoryTypes::eDevice`
	)

inline

Create a managed tensor that will be destroyed by this manager if it hasn't been destroyed by its reference count going to zero.

Parameters

data	The data to initialize the tensor with
tensorType	The type of tensor to initialize

Returns: Shared pointer with initialised tensor

◆ tensorT() [2/2]

template<typename T >

std::shared_ptr< TensorT< T > > kp::Manager::tensorT	(	size_t	size,
		Memory::MemoryTypes	tensorType = `Memory::MemoryTypes::eDevice`
	)

inline

Create a managed tensor that will be destroyed by this manager if it hasn't been destroyed by its reference count going to zero.

Parameters

size	The number of element in this tensor
tensorType	The type of tensor to initialize

Returns: Shared pointer with initialised tensor

The documentation for this class was generated from the following file:

/home/me/development/kompute/src/include/kompute/Manager.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Manager() [1/3]

◆ Manager() [2/3]

◆ Manager() [3/3]

◆ ~Manager()

Member Function Documentation

◆ algorithm() [1/2]

◆ algorithm() [2/2]

◆ clear()

◆ destroy()

◆ getDeviceProperties()

◆ getVkInstance()

◆ imageT()

◆ listDevices()

◆ sequence()

◆ tensorT() [1/2]

◆ tensorT() [2/2]