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

Improve basis docstrings #73

Open
billbrod opened this issue Dec 19, 2023 · 0 comments
Open

Improve basis docstrings #73

billbrod opened this issue Dec 19, 2023 · 0 comments

Comments

@billbrod
Copy link
Member

As described in #50 , I think basis docstrings should have a line or two before parameters that describe what the basis looks like and when you would use them. E.g., do they tile uniformly, are they each about the same size, what types of variables make sense (visual input, head direction, etc.). And then the footnote to references belongs in those lines (it looks weird in the docstring in jupyter or whatever to have the link right at the top).

Our documentation will have a longer discussion of the differences between the different basis functions, when to use them, etc., but something quick to give people some guidance will be helpful.

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