You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It would appear that energy_weight is β, and that the regularization weight is 1/α? Nonetheless, this relation is not made explicit. Would it be sensible to update the docs thusly?
sm=RMTC(
xlimits=xlimits,
num_elements=20,
energy_weight=1e-15, # corresponds to β in equation (1)regularization_weight=0.0, # corresponds to α in equation (1)
)
The text was updated successfully, but these errors were encountered:
I agree the mapping between the documentation and the API is not clear.
Actually, we should mention explicitely in the documentation the section 3.5 - Summary and implementation of the paper. It defines α'=α and β'=αβ which corresponds respectively to the energy_weight and the regularization_weight arguments (so the opposite of what is stated above).
In the documentation for RMTS, we see the equation
where "α and β are regularization coefficients". In the usage section, we see the example code
It would appear that
energy_weight
is β, and that the regularization weight is 1/α? Nonetheless, this relation is not made explicit. Would it be sensible to update the docs thusly?The text was updated successfully, but these errors were encountered: