Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document algorithm arguments #331

Open
gdalle opened this issue May 5, 2022 · 2 comments
Open

Document algorithm arguments #331

gdalle opened this issue May 5, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@gdalle
Copy link
Contributor

gdalle commented May 5, 2022

Hey there!
I'm playing more and more with your package, and I find it difficult to understand what every kwarg refers to, eg. here:

FrankWolfe.jl/src/afw.jl

Lines 10 to 35 in 7e8e3c8

function away_frank_wolfe(
f,
grad!,
lmo,
x0;
line_search::LineSearchMethod=Adaptive(),
L=Inf,
gamma0=0,
K=2.0,
step_lim=20,
epsilon=1e-7,
away_steps=true,
lazy=false,
momentum=nothing,
max_iteration=10000,
print_iter=1000,
trajectory=false,
verbose=false,
linesearch_tol=1e-7,
emphasis::Emphasis=memory,
gradient=nothing,
renorm_interval=1000,
callback=nothing,
timeout=Inf,
print_callback=print_callback,
)

Would it be possible to add a brief one-liner for each argument to the documentation?

@matbesancon
Copy link
Member

I agree it would be great to have an explanation for each of them. Not sure whether the docstring or the docs directly would be better as a location

@matbesancon matbesancon added the documentation Improvements or additions to documentation label May 6, 2022
@gdalle
Copy link
Contributor Author

gdalle commented May 6, 2022

I would put them in the docstring so that they can be displayed in the REPL

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants