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

Improved documentation about vector-valued callback function f(x; theta) #19

Open
ThomasEdwardRiley opened this issue May 27, 2022 · 0 comments

Comments

@ThomasEdwardRiley
Copy link

Is your feature request related to a problem? Please describe.

I used this great package for the first time in a few years, and I realized that it was not clear to me in the documentation whether the callback function f(x; theta) should be vectorized w.r.t x or not. The function should be vectorized looking at the source code and my previous usage. I cannot find a description of the expected output of function f(x; theta) in the documentation.

Describe the solution you'd like

I suggest the documentation states that the expected output of f(x; theta) is a vector of size equal to that of vector input x, and could be written using clearer notation that suggests a vector-valued function with vector-valued arguments. A user does not then need to encounter an error or look through source code to figure out the expected behavior of the callback function.

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

No branches or pull requests

1 participant