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

Revisit docs contents #221

Open
4 of 15 tasks
BalzaniEdoardo opened this issue Sep 12, 2024 · 0 comments
Open
4 of 15 tasks

Revisit docs contents #221

BalzaniEdoardo opened this issue Sep 12, 2024 · 0 comments

Comments

@BalzaniEdoardo
Copy link
Collaborator

BalzaniEdoardo commented Sep 12, 2024

Overview of the documentation refactoring plan:

  • Home: hyperlinks to some other references.
  • Quickstart: See issue Move Overview Chapter of index.md to quickstart.md #220
  • Install
  • Background: Theory focus, introduce GLM, convolution, basis. See Refactor Background #176
  • How-to-Guide: Assume background knowledge, show in depth what you can do with our functions
    • Model temporal effects with basis
    • Model fix non linearities with basis
    • Model multiple inputs
    • Take full advantage of pynapple & NeMoS
    • Regularization: types and when to use them
    • Model selection with sklearn
    • Fit large datasets
  • Tutorials: Fully worked out neural examples. Goal: teach good data analysis practices
  • API Guide: Assume background knowledge. Explanation of all functions and methods, and their parameters with minimal examples. See issue Add examples to all user-facing docstrings #177
  • For Developers: note facilitating new contributors explaining the internals of NeMoS machinery
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