dpctl.tensor.zeros¶
- dpctl.tensor.zeros(shape, *, dtype=None, order='C', device=None, usm_type='device', sycl_queue=None)[source]¶
Returns a new
dpctl.tensor.usm_ndarrayhaving a specified shape and filled with zeros.- Parameters:
shape (Tuple[int], int) – Dimensions of the array to be created.
dtype (optional) – data type of the array. Can be typestring, a
numpy.dtypeobject,numpychar string, or a NumPy scalar type. Default:Noneorder ("C", or "F") – memory layout for the array. Default:
"C"device (optional) – array API concept of device where the output array is created.
devicecan beNone, a oneAPI filter selector string, an instance ofdpctl.SyclDevicecorresponding to a non-partitioned SYCL device, an instance ofdpctl.SyclQueue, or adpctl.tensor.Deviceobject returned bydpctl.tensor.usm_ndarray.device. Default:Noneusm_type (
"device","shared","host", optional) – The type of SYCL USM allocation for the output array. Default:"device"sycl_queue (
dpctl.SyclQueue, optional) – The SYCL queue to use for output array allocation and copying.sycl_queueanddeviceare complementary arguments, i.e. use one or another. If both are specified, aTypeErroris raised unless both imply the same underlying SYCL queue to be used. If both areNone, a cached queue targeting default-selected device is used for allocation and population. Default:None
- Returns:
Constructed array initialized with zeros.
- Return type: