Skip to content

Contributing

Alexander Lenail edited this page Jan 14, 2019 · 3 revisions
  1. Bugfixes are always welcome!

  2. As the field develops, architectures other than the canonical FCNN, LeNet, and AlexNet may become widely adopted, and new ways of illustrating these architectures may become standard.

If you would like to add a new sort of parametric neural network illustration to this tool, I'm very open to pull requests. Here are some guidelines for the format your new diagramming tool should take:

  • The javascript should be wrapped in a closure (in the same way as the current tools), and expose at least the methods

    • redraw which should take structure variables and redraw the network
    • style which should take styling variables and style the network in accordance with those variables.
  • The tool should have a UI for tweaking each of the structure and styling variables in-browser, to permit users to interactively explore the parameter space of this particular type of architecture diagram. That UI can be a new tab on the NN-SVG homepage

  • Finally, you should expect to need to prove that this new diagramming tool is either needed by the field or standard in the field. Sufficient to prove that would be to show at least two academic papers with the same sort of diagram, one of which should be relatively well cited. Otherwise, I will refrain from adding this new architecture style to the homepage, but will instead point to your fork in the homepage.

Clone this wiki locally