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

Documentation masterplan #1018

Open
23 tasks
awf opened this issue Aug 17, 2021 · 0 comments
Open
23 tasks

Documentation masterplan #1018

awf opened this issue Aug 17, 2021 · 0 comments
Labels
rolling issue An issue that exists largely to document some process

Comments

@awf
Copy link
Contributor

awf commented Aug 17, 2021 •
edited
Loading

Items that should be in a "users" doc:

  • Installing
  • Python decorators etc
  • Controlling compilation - when and where
  • Benchmarks
  • Examples of things that don't currently work that should
  • Examples of cool things that do work: recursion, conditionals, ...

Items that should be in a "contributors" doc:

  • Copydown
  • AD
  • Bump allocation
  • The IR: Types, AST nodes
  • Prims
  • Derived functions: AD, shape, cost
  • prelude.ks
  • knossos.h
  • Torch interop
  • ks::Tensor
  • Linear maps
  • Rewriting and rules
  • if-with-proof
  • Architecture: what is Haskell, Python, C++, etc...
  • Meta topics: recursion in the IR
  • Interpreters/compilers: JAX, absint, ...
  • Destination Passing Style (if not already?)

Please add more to the above - the list is currently unordered, order will be applied when it looks to be >50% complete.
@awf awf changed the title Documentation: Contributors Documentation masterplan Aug 17, 2021
@awf awf pinned this issue Aug 17, 2021
@awf awf added the rolling issue An issue that exists largely to document some process label Aug 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
rolling issue An issue that exists largely to document some process
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@awf