Documentation masterplan - Githubissues

microsoft / knossos-ksc

Compiler with automatic differentiation

Other

45 stars 10 forks source link

Documentation masterplan #1018

Open awf opened 2 years ago

awf commented 2 years ago

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.