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.

Sign up for GitHub

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

Jump to bottom

Improve Documentation #8

Open
3 of 6 tasks
kmheckel opened this issue Oct 1, 2023 · 0 comments
Open
3 of 6 tasks

Improve Documentation #8

kmheckel opened this issue Oct 1, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@kmheckel
Copy link
Owner

kmheckel commented Oct 1, 2023 •
edited
Loading

The current documentation is passable but it could always be better.

  • Make spyx.nn listings cleaner by removing unwanted special-members
  • Incorporate notebooks from the examples/research folders.
  • More math equations for surrogate gradient functions in spyx.axn
  • Write intro and quickstart pages
  • Add documentation/tutorial for NIR exporting beyond the sample notebooks.demo
  • Add better return type annotations showing the arguments for callables returned by HOFs/function builders.
@kmheckel kmheckel added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Oct 1, 2023
@kmheckel kmheckel moved this to In Progress in Spyx Version 0.2.0 Oct 30, 2023
@kmheckel kmheckel removed the help wanted Extra attention is needed label Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
Spyx Version 0.2.0
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kmheckel