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 docstrings #20

Open
jwdink opened this issue Apr 18, 2024 · 0 comments
Open

Improve docstrings #20

jwdink opened this issue Apr 18, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jwdink
Copy link
Collaborator

jwdink commented Apr 18, 2024

One notable issue is usage of kwargs. For example, StateSpaceModel().fit() ultimately calls StateSpaceModel().forward(), and passing kwargs on to that method. This makes it difficult for someone who's working with fit() to know all their options (e.g. n_step).

@jwdink jwdink self-assigned this Apr 18, 2024
@jwdink jwdink added the documentation Improvements or additions to documentation label Apr 18, 2024
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

1 participant