I've been working all day with Doxygen and the temporal pooler (py/nupic/research/TP.py), and I've got some initial docs[1].
This URL is temporary and the docs are still incomplete (I haven't even started on the TP implementations yet), but I wanted to see if it was useful to anyone. This is really just a beginning pass at documentation, and I'm going to be moving on to nta/engine to doc the Regions and other API components next. I'll be leaving a lot of @todo items in my wake, and hopefully some of you can come along and help fill in the docs after me. All my work is on a remote branch[2]. As you can see[3], this is a tedious and work-intensive task, but I think it will pay off greatly in the end. Once I get a few more components documented and some of the styling cleaned up, I'll work on getting this automated[4]. Feedback welcome. --------- Matt Taylor OS Community Flag-Bearer Numenta [1] http://issues.numenta.org:8888/classnupic_1_1research_1_1_t_p_1_1_t_p.html [2] https://github.com/rhyolight/nupic/tree/doxygen [3] https://github.com/rhyolight/nupic/commit/97ba4918b40a17b3afa3ba135cd9e7767181d54a [4] https://github.com/numenta/nupic/issues/452 _______________________________________________ nupic mailing list [email protected] http://lists.numenta.org/mailman/listinfo/nupic_lists.numenta.org
