Skip to content

Commit dd7736b

Browse files
committed
Fix Tucker rank search iterating past the requested maximum rank
Fixes #65 Claude-Session: https://claude.ai/code/session_01JZGNmz4nWXtZMaKkbMEfPy
1 parent 295ea83 commit dd7736b

3 files changed

Lines changed: 72 additions & 45 deletions

File tree

‎tensorpack/decomposition.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def perform_tfac(self):
3939

4040
def perform_tucker(self):
4141
""" Try out Tucker for up to a specific number of ranks. """
42-
self.Tucker, self.TuckErr, self.TuckRank = self.method(self.data, max(self.rrs)+1)
42+
self.Tucker, self.TuckErr, self.TuckRank = self.method(self.data, max(self.rrs))
4343

4444
def perform_PCA(self, flattenon=0):
4545
dataShape = self.data.shape

‎tensorpack/test/test_decomposition.py‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,29 @@ def test_known_rank():
6767
assert np.all([newtFac[ii + 1] > newtFac[ii] for ii in range(len(newtFac) - 1)])
6868
assert newtFac[0] > 0.0
6969
assert newtFac[-1] < 1.0
70+
71+
72+
def test_tucker_ranks_bounded():
73+
"""Tucker rank search never exceeds num_comps (or a mode's size) and grows one mode per step."""
74+
shape = (6, 5, 2)
75+
tensor = np.random.rand(*shape)
76+
num_comps = 3
77+
factors, errs, ranks = tucker_decomp(tensor, num_comps)
78+
79+
max_rank = [min(num_comps, s) for s in shape]
80+
assert len(factors) == len(errs) == len(ranks)
81+
assert ranks[0] == [1, 1, 1]
82+
assert ranks[-1] == max_rank
83+
assert len(ranks) == 1 + sum(m - 1 for m in max_rank)
84+
for prev, cur in zip(ranks[:-1], ranks[1:]):
85+
assert sum(c - p for p, c in zip(prev, cur)) == 1
86+
assert all(c >= p for p, c in zip(prev, cur))
87+
assert all(np.all(np.array(r) <= max_rank) for r in ranks)
88+
89+
90+
def test_decomposition_tucker_max_rank():
91+
"""Decomposition(max_rr=N).perform_tucker() tests ranks up to N, not beyond."""
92+
tensor = np.random.rand(6, 5, 4)
93+
d = Decomposition(tensor, max_rr=2, method=tucker_decomp)
94+
d.perform_tucker()
95+
assert max(max(r) for r in d.TuckRank) == 2

‎tensorpack/tucker.py‎

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,45 @@
44
from tensorly.decomposition import tucker
55

66

7+
def _fit_tucker(tensor_filled, mask, rank):
8+
"""Fit one masked Tucker decomposition; return the fit and its squared error."""
9+
fit, errors = tucker(
10+
tensor_filled,
11+
rank=rank,
12+
svd="randomized_svd",
13+
tol=1e-8,
14+
mask=mask,
15+
return_errors=True,
16+
)
17+
return fit, errors[-1] ** 2.0
18+
19+
720
def tucker_decomp(tensor, num_comps: int):
8-
"""Performs Tucker decomposition.
21+
"""Performs Tucker decomposition, greedily growing the rank of one mode at a time.
22+
23+
Starting from rank 1 along every mode, each step increases the rank of
24+
whichever single mode lowers the reconstruction error the most. A mode is
25+
no longer considered once its rank reaches ``min(num_comps, size of that
26+
mode)``, so no mode is ever given a rank above ``num_comps`` and the search
27+
ends once every mode has reached its limit.
928
1029
Parameters
1130
----------
1231
tensor : xarray or ndarray
1332
multi-dimensional data input
1433
num_comps : int
15-
the number of components.
34+
the maximum rank to test along each mode.
1635
1736
Returns
1837
-------
1938
factors : list of lists
2039
containing tucker factorization object of each rank.
2140
min_err : list
22-
list of minimum errors of tensor reconstruction for each sum of components.
23-
min_err_rank : list of tuples
24-
list of the corresponding ranks combinations for the minimum error.
41+
list of minimum errors of tensor reconstruction for each rank combination.
42+
min_err_rank : list of lists
43+
list of the corresponding rank combinations (one rank per mode) for the
44+
minimum error. The first entry is all ones; each later entry differs
45+
from the previous one by +1 in exactly one mode.
2546
"""
2647

2748
# if tensor is xarray...
@@ -30,51 +51,31 @@ def tucker_decomp(tensor, num_comps: int):
3051

3152
mask = np.isfinite(tensor)
3253
tensor_filled = np.nan_to_num(tensor)
54+
max_rank = [min(num_comps, size) for size in tensor.shape]
3355

3456
# step 1 with 1 component along every dimension
35-
start = [1] * tensor.ndim
36-
ff, errors = tucker(
37-
tensor_filled,
38-
rank=start,
39-
svd="randomized_svd",
40-
tol=1e-8,
41-
mask=mask,
42-
return_errors=True,
43-
)
44-
factors = [ff]
45-
min_err = [errors[-1] ** 2.0]
46-
min_rank = [start]
47-
ranks = min_rank * tensor.ndim
57+
rank = [1] * tensor.ndim
58+
fit, err = _fit_tucker(tensor_filled, mask, rank)
59+
factors = [fit]
60+
min_err = [err]
61+
min_rank = [rank]
4862

49-
for _ in range(tensor.ndim * num_comps):
50-
fac = []
51-
err = []
52-
rnk = []
53-
for indx, val in enumerate(ranks):
54-
temp_rank = val.copy()
55-
temp_rank[indx] = val[indx] + 1
56-
57-
if temp_rank[indx] > tensor.shape[indx]:
63+
while True:
64+
candidates = []
65+
for mode in range(tensor.ndim):
66+
if rank[mode] >= max_rank[mode]:
5867
continue
68+
temp_rank = rank.copy()
69+
temp_rank[mode] += 1
70+
candidates.append((temp_rank, *_fit_tucker(tensor_filled, mask, temp_rank)))
5971

60-
# calculate error for this rank combination
61-
ff, errors = tucker(
62-
tensor_filled,
63-
rank=temp_rank,
64-
svd="randomized_svd",
65-
tol=1e-8,
66-
mask=mask,
67-
return_errors=True,
68-
)
69-
fac.append(ff)
70-
err.append(errors[-1] ** 2.0)
71-
rnk.append(temp_rank)
72+
if not candidates:
73+
break
7274

7375
# pick the lowest error and continue with that
74-
min_err.append(min(err))
75-
min_rank.append(rnk[err.index(min(err))])
76-
factors.append(fac[err.index(min(err))])
77-
78-
ranks = [min_rank[-1]] * tensor.ndim
76+
rank, fit, err = min(candidates, key=lambda c: c[2])
77+
factors.append(fit)
78+
min_err.append(err)
79+
min_rank.append(rank)
7980

8081
return factors, min_err, min_rank

0 commit comments

Comments
 (0)