Improve docs of cast
@@ -26,11 +26,27 @@ def cast(x, typ):
"""Cast an input variable to a given type.
Args:
- x (~chainer.Variable): Input variable.
- typ (str of dtype): Typecode or data type to cast.
+ x (:class:`~chainer.Variable` or :class:`numpy.ndarray` or \
+ :class:`cupy.ndarray`):
+ Input variable to be casted. A \
+ :math:`(s_1, s_2, ..., s_N)`-shaped float array.
+ typ (:class:`str` of dtype or :class:`numpy.dtype`):
+ Typecode or data type to cast.
Returns:
~chainer.Variable: Variable holding a casted array.
+ .. admonition:: Example
+
+ >>> x = np.arange(0, 3, dtype=np.float64)
+ >>> x.dtype
+ dtype('float64')
+ >>> y = F.cast(x, np.float32)
+ >>> y.dtype
+ dtype('float32')
+ >>> y = F.cast(x, 'float16')
+ >>> y.dtype
+ dtype('float16')
+
"""
return Cast(typ)(x)
