API definition update

This commit is contained in:
Evgenii Zheltonozhskii 2019-10-11 22:02:52 +03:00
parent a973c584a6
commit cf27a56bbf

View File

@ -0,0 +1,45 @@
op {
graph_op_name: "Eig"
endpoint {
name: "Eig"
}
in_arg {
name: "input"
description: <<END
`Tensor` input of shape `[N, N]`.
END
}
out_arg {
name: "e"
description: <<END
Eigenvalues. Shape is `[N]`.
END
}
out_arg {
name: "v"
description: <<END
Eigenvectors. Shape is `[N, N]`.
END
}
attr {
name: "compute_v"
description: <<END
If `True` then eigenvectors will be computed and returned in `v`.
Otherwise, only the eigenvalues will be computed.
END
}
summary: "Computes the eigen decomposition of one or more square matrices."
description: <<END
Computes the eigenvalues and (optionally) right eigenvectors of each inner matrix in
`input` such that `input[..., :, :] = v[..., :, :] * diag(e[..., :])`. The eigenvalues
are sorted in non-decreasing order.
```python
# a is a tensor.
# e is a tensor of eigenvalues.
# v is a tensor of eigenvectors.
e, v = eig(a)
e = eig(a, compute_v=False)
```
END
}