MatrixSign

Documentation for MatrixSign, largely based on the paper The Polar Express: Optimal Matrix Sign Methods and Their Application to the Muon Algorithm

API

MatrixSign.msign!Function
msign!(X::AbstractArray, method=PolarExpress; kws...)

Return the sign of X using the PolarExpress method as the default, mutating X in-place.

source

Methods

MatrixSign.SVDMethodType
SVDMethod

Uses a costly singular value decomposition to compute the sign of a matrix.

Let $\bold{M} = U\Sigma V^T$ be the singular value decomposition of $\bold{M}$. Then the sign, or more generally polar factor, of $\bold{M}$ is given by $UV^T$.

source