Skip to content

Drop kappa from the A2Grad examples - #558

Open
shaneraphel wants to merge 1 commit into
jettify:masterfrom
shaneraphel:readme-a2grad-kappa
Open

shaneraphel wants to merge 1 commit into
jettify:masterfrom
shaneraphel:readme-a2grad-kappa

Conversation

@shaneraphel

@shaneraphel shaneraphel commented Sep 25, 2026 •

Copy link
Copy Markdown

Summary

Fixes #468. The README examples for A2GradExp, A2GradInc and A2GradUni pass kappa=1000.0. Those three constructors do not take kappa (A2GradExp takes beta, lips and rho; the other two take beta and lips), so copying the example raises TypeError. kappa belongs to AccSGD, and that example is left as it is.

Test plan

  • Constructed each A2Grad class with the arguments that remain in the example. None of the param groups contains kappa.
  • AccSGD(..., kappa=1000.0) still stores that value.

This change was produced with assistance from an AI coding tool. I checked the three constructors against the examples and removed only the argument they reject.

A2GradExp, A2GradInc and A2GradUni do not take kappa. The README
examples passed it and raised TypeError (issue 468). AccSGD is the
optimizer that uses kappa, and its example is unchanged.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix readme kappa

1 participant