Skip to content

All tensor functions docstrings should provide a short description #1116

@diptorupd

Description

@diptorupd

Some dpctl.tensor functions do not provide a short description. For example,

arange() -> usm_ndarray Args: start: device (optional): array API concept of device where the output array is created. device can be None, a oneAPI filter selector string, an instance of dpctl.SyclDevice corresponding to a non-partitioned SYCL device, an instance of dpctl.SyclQueue, or a Device object returned by dpctl.tensor.usm_array.device. Default: None.

The description of arange is hard to parse and understand.

A better example is

astype() Returns a copy of the array, cast to a specified type.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions