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

Fix documentation #10

Open
4 of 8 tasks
bhavnicksm opened this issue Feb 20, 2023 · 1 comment
Open
4 of 8 tasks

Fix documentation #10

bhavnicksm opened this issue Feb 20, 2023 · 1 comment
Assignees
@bhavnicksm

Comments

@bhavnicksm
Copy link
Contributor

bhavnicksm commented Feb 20, 2023 •
edited by apzl
Loading

Currently, the documentation is extremely stale and requires us to do the following things:

  • Write an introduction about Nadir, the plan behind it, the meaning of the name and more
  • Add a table to show the papers/optimisers already implemented in Nadir
  • Show usage for a general optimiser in Nadir
  • provide how to install for Nadir
  • Have some sort of imagery or emoji because the README looks kinda bland
  • Add a coming soon optimisers to the table
  • Add Acknowledgements to different implementations in the past
  • Change citation
@apzl apzl mentioned this issue Feb 23, 2023
Merged
@nithinkr2000
Copy link
Collaborator

nithinkr2000 commented Feb 24, 2023 •
edited by bhavnicksm
Loading

  • What is Nadir?
  • What changes are planned for the future?

@bhavnicksm bhavnicksm self-assigned this Jun 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bhavnicksm bhavnicksm

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bhavnicksm @nithinkr2000