-
Notifications
You must be signed in to change notification settings - Fork 8
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
Doc/glossary #537
Doc/glossary #537
Conversation
The new Glossary page makes the Methods page a bit redundant because it contains descriptions of some of the methods as well as links to the implementations. Perhaps we can keep method descriptions in Methods and only put other terms in the Glossary. |
Well... you suggested it 😅 But I'm not sure it's redundant. The methods page is a quick list with links for reference for newcomers ("is my algorithm here?"). Whereas the glossary is for quick definitions that can be linked from anywhere. I would imagine that in time, if we really want the glossary to be useful, we'd cross-ref to it from all over the docs, possibly adding a little tooltip with the definition (using e.g. the couple of js+css files suggested here). |
Co-authored-by: Anes Benmerzoug <[email protected]>
That sounds like a lot of work. I think we can merge it now as it is. |
* add Arnoldi, Nyström, Block CG, Preconditioners * add documentation links to Lissa and EKFAC
…let list in glossary.md
Doc/glossary influence
Description
This PR adds a glossary page. I almost exclusively took terms from
abbreviations.md
but we should add more that are relevant to pydvl. Links to wikipedia / other sources might be in order too.@schroedk the influence part is again a stub, please check it for consistency and completeness. @AnesBenmerzoug let me know of any terms that you miss and I'll try to add them.
At some point we will want to link to these from other docs. So maybe I'll try adding explicit anchors with
{ #anchor }
, although that has not really worked out so well in the past.Changes
Checklist
Wrote Unit tests (if necessary)If notebooks were added/changed, added boilerplate cells are tagged with"tags": ["hide"]
or"tags": ["hide-input"]