rankest

# Import statement

from hottbox.rank import rankest

rankest(tensor, rank_range, epsilon=0.01, verbose=False)

Estimate the optimal Kruskal rank of a tensor

Parameters

tensorTensor

Multi-dimensional data which Kruskal rank is to be estimated

rank_rangelist[int]

List of rank values to be tested

epsilonfloat

Threshold for the relative error of approximation.

verbosebool

Enable verbose output

Returns

optimal_ranktuple

Optimal Kruskal rank. For consistency, the type of the returned value is tuple