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

Create glossary for terms used in the project #117

Open
mattBrzezinski opened this issue Jan 22, 2020 · 7 comments · May be fixed by #222
Open

Create glossary for terms used in the project #117

mattBrzezinski opened this issue Jan 22, 2020 · 7 comments · May be fixed by #222
Assignees
@thomasgudjonwright
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@mattBrzezinski
Copy link
Member

It would be nice to have a quick reference for terms used throughout our documentation, a glossary page would be very useful for this.
@mattBrzezinski mattBrzezinski added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 22, 2020
@mattBrzezinski mattBrzezinski mentioned this issue Jan 22, 2020
Merged
@oxinabox
Copy link
Member

oxinabox commented Jan 22, 2020 •
edited
Loading

Can we list?
I will start:

  • jvp
  • vjp
  • pushforward
  • pullback

@nickrobinson251
Copy link
Contributor

  • Primal
  • Differential

@nickrobinson251
Copy link
Contributor

Potentially

  • adjoint
  • gradient
  • jacobian

@oxinabox
Copy link
Member

Primal is a half dozen things we should define them all.

@oxinabox
Copy link
Member

@mattBrzezinski I wonder if the best way to do this to ensure the results are easily understandable is:

  1. make a big list
  2. you and I sit down in a video call (or in person? want to come to Cambridge?) and I answer any and all questions you have and you take notes
  3. you write a PR
  4. I review the PR and make sure it is correct.
  5. optional step: we throw it to the open source world and let then make further suggestions

@mattBrzezinski
Copy link
Member Author

When I got some free time I'll go through the documentation and find all the terms which could use some more definitions.

I will be in Cambridge hopefully sometime in March and we can chat some more then you can fill me in on the more intricate details!

@nickrobinson251
Copy link
Contributor

https://fluxml.ai/Zygote.jl/latest/glossary/

@thomasgudjonwright thomasgudjonwright linked a pull request Sep 25, 2020 that will close this issue
Open
@oxinabox oxinabox mentioned this issue Nov 10, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thomasgudjonwright thomasgudjonwright

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Addition of generic / introductory glossary thomasgudjonwright/ChainRulesCore.jl
4 participants
@mattBrzezinski @oxinabox @nickrobinson251 @thomasgudjonwright