Struct cubecl_core::client::ComputeClient

pub struct ComputeClient<Server, Channel>
where
    Server: ComputeServer,
{ /* private fields */ }

The ComputeClient is the entry point to require tasks from the ComputeServer. It should be obtained for a specific device via the Compute struct.

Implementations

impl<Server, Channel> ComputeClient<Server, Channel>

where Server: ComputeServer, Channel: ComputeChannel<Server>,

pub fn new( channel: Channel, features: Arc<<Server as ComputeServer>::FeatureSet>, ) -> ComputeClient<Server, Channel>

Create a new client.

pub async fn read_async(&self, binding: Binding<Server>) -> Vec<u8>

Given a binding, returns owned resource as bytes.

pub fn read(&self, binding: Binding<Server>) -> Vec<u8>

Given a binding, returns owned resource as bytes.

Remarks

Panics if the read operation fails.

pub fn get_resource( &self, binding: Binding<Server>, ) -> <<Server as ComputeServer>::Storage as ComputeStorage>::Resource

Given a resource handle, returns the storage resource.

pub fn create(&self, data: &[u8]) -> Handle<Server>

Given a resource, stores it and returns the resource handle.

pub fn empty(&self, size: usize) -> Handle<Server>

Reserves size bytes in the storage, and returns a handle over them.

pub fn execute( &self, kernel: <Server as ComputeServer>::Kernel, count: <Server as ComputeServer>::DispatchOptions, bindings: Vec<Binding<Server>>, )

Executes the kernel over the given bindings.

pub unsafe fn execute_unchecked( &self, kernel: <Server as ComputeServer>::Kernel, count: <Server as ComputeServer>::DispatchOptions, bindings: Vec<Binding<Server>>, )

Executes the kernel over the given bindings without performing any bound checks.

Safety

Without checks, the out-of-bound reads and writes can happen.

pub fn sync(&self, sync_type: SyncType)

Wait for the completion of every task in the server.

pub fn features(&self) -> &<Server as ComputeServer>::FeatureSet

Get the features supported by the compute server.

Trait Implementations

impl<S, C> Clone for ComputeClient<S, C>

where S: ComputeServer, C: ComputeChannel<S>,

fn clone(&self) -> ComputeClient<S, C>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Server, Channel> Debug for ComputeClient<Server, Channel>

where Server: Debug + ComputeServer, Channel: Debug, <Server as ComputeServer>::FeatureSet: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.