axon icon indicating copy to clipboard operation
axon copied to clipboard

Add guides to documentation

Open seanmor5 opened this issue 3 years ago • 1 comments

Here is an (incomplete) list of guides that should be added to the documentation:

  • [ ] Basic Axon models
  • [ ] Complex Models (combinators, weight sharing, etc.)
  • [ ] Working with Named Tensors (requires #57)
  • [ ] Training and Evaluating Axon models
  • [ ] Creating Custom Layers
  • [ ] Custom Training Loops
  • [ ] Creating Custom Event Handlers and Metrics
  • [ ] Mixed Precision Training
  • [ ] Axon Graph Manipulation (requires #117)
  • [ ] Pruning trained models (requires #120)
  • [ ] Model Serialization and Saving (requires #26)
  • [ ] Hooks (requires #77)
  • [ ] Axon Optimization Deep Dive
  • [ ] Transfer Learning and Fine Tuning

Note these differ from examples of specific applications of Axon as they are intended to be example based deep dives of certain aspects of the API.

seanmor5 avatar Nov 07 '21 18:11 seanmor5

Just a note: Livebook supports links in more recent versions, so you can have a root guide that points to all other guides. :)

josevalim avatar Nov 07 '21 19:11 josevalim