From 95febdfacc112158565561e374819396dfd88861 Mon Sep 17 00:00:00 2001 From: vishwakftw Date: Mon, 7 Jan 2019 10:38:16 -0800 Subject: Add is_floating_point to docs (#15704) Summary: Fixes #15700 . Changelog: - Expose torch.*.is_floating_point to docs Differential Revision: D13580734 Pulled By: zou3519 fbshipit-source-id: 76edb4af666c08237091a2cebf53d9ba5e6c8909 --- docs/source/tensor_attributes.rst | 3 +++ docs/source/tensors.rst | 1 + docs/source/torch.rst | 1 + 3 files changed, 5 insertions(+) (limited to 'docs') diff --git a/docs/source/tensor_attributes.rst b/docs/source/tensor_attributes.rst index 230b74d7dd..8233211dba 100644 --- a/docs/source/tensor_attributes.rst +++ b/docs/source/tensor_attributes.rst @@ -30,6 +30,9 @@ Data type dtype Tensor 64-bit integer (signed) ``torch.int64`` or ``torch.long`` ``torch.*.LongTensor`` ======================== =========================================== =========================== +To find out if a :class:`torch.dtype` is a floating point data type, the property :attr:`is_floating_point` +can be used, which returns ``True`` if the data type is a floating point data type. + .. _device-doc: torch.device diff --git a/docs/source/tensors.rst b/docs/source/tensors.rst index 977cf2b52f..4e89392082 100644 --- a/docs/source/tensors.rst +++ b/docs/source/tensors.rst @@ -259,6 +259,7 @@ view of a storage and defines numeric operations on it. .. automethod:: int .. automethod:: inverse .. automethod:: is_contiguous + .. automethod:: is_floating_point .. automethod:: is_pinned .. automethod:: is_set_to .. automethod:: is_signed diff --git a/docs/source/torch.rst b/docs/source/torch.rst index eb34f1ac70..f04b7fb21a 100644 --- a/docs/source/torch.rst +++ b/docs/source/torch.rst @@ -6,6 +6,7 @@ Tensors ---------------------------------- .. autofunction:: is_tensor .. autofunction:: is_storage +.. autofunction:: is_floating_point .. autofunction:: set_default_dtype .. autofunction:: get_default_dtype .. autofunction:: set_default_tensor_type -- cgit v1.2.3