Skip to main content

Ctrl+K

Home
Get Started
Quickstart
Learn the basics
Guides
Examples and Demos
Motivation
Related Work
Design
Contributing
Contributor Leaderboard
Deep Dive
Glossary
FAQ
One liners
Functions
Data classes
Framework classes
Utils
Testing

Home

The Basics

Get Started
Quickstart

Demos

Learn the basics
Guides
- Transpiling a PyTorch model to build on top
- Transpiling a Tensorflow model to build on top
Examples and Demos

Background

Motivation
Related Work

Contributors

Design
Contributing
Contributor Leaderboard
Deep Dive
Glossary
FAQ

API Reference

One liners

Functions
- Activations
  - gelu
  - hardswish
  - leaky_relu
  - log_softmax
  - mish
  - relu
  - sigmoid
  - softmax
  - softplus
  - softsign
- Constants
- Control flow ops
  - cmp_is
  - cmp_isnot
  - for_loop
  - if_else
  - try_except
  - while_loop
- Creation
  - arange
  - array
  - asarray
  - copy_array
  - empty
  - empty_like
  - eye
  - from_dlpack
  - frombuffer
  - full
  - full_like
  - linspace
  - logspace
  - meshgrid
  - native_array
  - one_hot
  - ones
  - ones_like
  - to_dlpack
  - tril
  - triu
  - triu_indices
  - zeros
  - zeros_like
- Data type
- Device
- Elementwise
  - abs
  - acos
  - acosh
  - add
  - angle
  - asin
  - asinh
  - atan
  - atan2
  - atanh
  - bitwise_and
  - bitwise_invert
  - bitwise_left_shift
  - bitwise_or
  - bitwise_right_shift
  - bitwise_xor
  - ceil
  - cos
  - cosh
  - deg2rad
  - divide
  - equal
  - erf
  - exp
  - exp2
  - expm1
  - floor
  - floor_divide
  - fmin
  - fmod
  - gcd
  - greater
  - greater_equal
  - imag
  - isfinite
  - isinf
  - isnan
  - isreal
  - lcm
  - less
  - less_equal
  - log
  - log10
  - log1p
  - log2
  - logaddexp
  - logaddexp2
  - logical_and
  - logical_not
  - logical_or
  - logical_xor
  - maximum
  - minimum
  - multiply
  - nan_to_num
  - negative
  - not_equal
  - positive
  - pow
  - rad2deg
  - real
  - reciprocal
  - remainder
  - round
  - sign
  - sin
  - sinh
  - sqrt
  - square
  - subtract
  - tan
  - tanh
  - trapz
  - trunc
  - trunc_divide
- Experimental
  - Activations
    - celu
    - elu
    - hardshrink
    - hardsilu
    - hardtanh
    - logit
    - logsigmoid
    - prelu
    - relu6
    - scaled_tanh
    - selu
    - silu
    - softshrink
    - stanh
    - tanhshrink
    - threshold
    - thresholded_relu
  - Constants
  - Creation
  - Data type
  - Device
  - Elementwise
    - allclose
    - amax
    - amin
    - binarizer
    - conj
    - copysign
    - count_nonzero
    - diff
    - digamma
    - erfc
    - erfinv
    - fix
    - float_power
    - fmax
    - frexp
    - gradient
    - hypot
    - isclose
    - ldexp
    - lerp
    - lgamma
    - modf
    - nansum
    - nextafter
    - signbit
    - sinc
    - sparsify_tensor
    - xlogy
    - zeta
  - General
    - reduce
  - Gradients
  - Layers
    - adaptive_avg_pool1d
    - adaptive_avg_pool2d
    - adaptive_max_pool2d
    - adaptive_max_pool3d
    - area_interpolate
    - avg_pool1d
    - avg_pool2d
    - avg_pool3d
    - dct
    - dft
    - dropout1d
    - dropout2d
    - dropout3d
    - embedding
    - fft
    - fft2
    - generate_einsum_equation
    - get_interpolate_kernel
    - idct
    - ifft
    - ifftn
    - interp
    - interpolate
    - max_pool1d
    - max_pool2d
    - max_pool3d
    - max_unpool1d
    - nearest_interpolate
    - pool
    - reduce_window
    - rfft
    - rfftn
    - rnn
    - sliding_window
    - stft
  - Linear algebra
  - Losses
  - Manipulation
    - as_strided
    - associative_scan
    - atleast_1d
    - atleast_2d
    - atleast_3d
    - broadcast_shapes
    - check_scalar
    - choose
    - column_stack
    - concat_from_sequence
    - dsplit
    - dstack
    - expand
    - fill_diagonal
    - flatten
    - fliplr
    - flipud
    - fold
    - heaviside
    - hsplit
    - hstack
    - i0
    - matricize
    - moveaxis
    - pad
    - partial_fold
    - partial_tensor_to_vec
    - partial_unfold
    - partial_vec_to_tensor
    - put_along_axis
    - rot90
    - soft_thresholding
    - take
    - take_along_axis
    - top_k
    - trim_zeros
    - unflatten
    - unfold
    - unique_consecutive
    - vsplit
    - vstack
  - Meta
  - Nest
  - Norms
  - Random
    - bernoulli
    - beta
    - dirichlet
    - gamma
    - poisson
  - Searching
    - unravel_index
  - Set
  - Sorting
    - invert_permutation
    - lexsort
  - Sparse array
  - Statistical
    - bincount
    - corrcoef
    - cov
    - cummax
    - cummin
    - histogram
    - igamma
    - median
    - nanmean
    - nanmedian
    - nanmin
    - nanprod
    - quantile
  - Utility
    - optional_get_element
- General
- Gradients
- Layers
- Linear algebra
  - cholesky
  - cross
  - det
  - diag
  - diagonal
  - eig
  - eigh
  - eigvalsh
  - inner
  - inv
  - matmul
  - matrix_norm
  - matrix_power
  - matrix_rank
  - matrix_transpose
  - outer
  - pinv
  - qr
  - slogdet
  - solve
  - svd
  - svdvals
  - tensordot
  - tensorsolve
  - trace
  - vander
  - vecdot
  - vector_norm
  - vector_to_skew_symmetric_matrix
- Losses
- Manipulation
  - clip
  - concat
  - constant_pad
  - expand_dims
  - flip
  - permute_dims
  - repeat
  - reshape
  - roll
  - split
  - squeeze
  - stack
  - swapaxes
  - tile
  - unstack
  - zero_pad
- Meta
- Nest
- Norms
  - layer_norm
- Random
  - multinomial
  - randint
  - random_normal
  - random_uniform
  - seed
  - shuffle
- Searching
  - argmax
  - argmin
  - argwhere
  - nonzero
  - where
- Set
- Sorting
  - argsort
  - msort
  - searchsorted
  - sort
- Statistical
  - cumprod
  - cumsum
  - einsum
  - max
  - mean
  - min
  - prod
  - std
  - sum
  - var
- Utility
  - all
  - any
  - load
  - save

Data classes
- Array
  - Activations
  - Conversions
  - Creation
  - Data type
  - Device
  - Elementwise
  - Experimental
  - General
  - Gradients
  - Image
  - Layers
  - Linear algebra
  - Losses
  - Manipulation
  - Norms
  - Random
  - Searching
  - Set
  - Sorting
  - Statistical
  - Utility
  - Wrapping
- Container
  - Activations
  - Base
  - Conversions
  - Creation
  - Data type
  - Device
  - Elementwise
  - Experimental
  - General
  - Gradients
  - Image
  - Layers
  - Linear algebra
  - Losses
  - Manipulation
  - Norms
  - Random
  - Searching
  - Set
  - Sorting
  - Statistical
  - Utility
  - Wrapping
- Factorized tensor
- Nested array
  - Base
  - Elementwise

Framework classes
- Activations
- Converters
- Helpers
- Initializers
- Layers
- Losses
- Module
- Norms
- Optimizers
- Sequential
Utils
Testing

Functions
Manipulation
check_scalar

check_scalar#

ivy.check_scalar(x, force_integer, force_positive)[source]#

On this page

check_scalar()

Created using Sphinx 7.2.5.

Built with the PyData Sphinx Theme 0.15.2.