View source on GitHub

Assert x has rank equal to rank.

    x, rank, data=None, summarize=None, message=None, name=None

Example of adding a dependency to an operation:

with tf.control_dependencies([tf.compat.v1.assert_rank(x, 2)]):
  output = tf.reduce_sum(x)


  • x: Numeric Tensor.
  • rank: Scalar integer Tensor.
  • data: The tensors to print out if the condition is False. Defaults to error message and the shape of x.
  • summarize: Print this many entries of each tensor.
  • message: A string to prefix to the default message.
  • name: A name for this operation (optional). Defaults to "assert_rank".


Op raising InvalidArgumentError unless x has specified rank. If static checks determine x has correct rank, a no_op is returned.


  • ValueError: If static checks determine x has wrong rank.