I've recently added documentation for:
Network: http://numenta.org/docs/classnta_1_1_network.html
Region: http://numenta.org/docs/classnta_1_1_region.html
Link: http://numenta.org/docs/classnta_1_1_link.html
Input: http://numenta.org/docs/classnta_1_1_input.html
Output: http://numenta.org/docs/classnta_1_1_output.html
You can see the entire `nta` namspace here:
http://numenta.org/docs/namespacenta.html
There are a lot of holes in this documentation, where I've added
"TODO: document". We also need some tutorials on how to use this API,
but this is a start.
If anyone wants to help, please feel free:
https://github.com/numenta/nupic/wiki/Documenting-NuPIC-with-Doxygen
---------
Matt Taylor
OS Community Flag-Bearer
Numenta
On Fri, Dec 13, 2013 at 11:39 AM, Mark Wilson <[email protected]> wrote:
> Ok, ignore that. Just read the later email with http://numenta.org/docs
>
>
> On 13 December 2013 19:23, Mark Wilson <[email protected]> wrote:
>>
>> I still have problems - looks like there is nothing listening.
>>
>> mark@gorgonzola:~$ nc -v issues.numenta.org 8888
>> nc: connect to issues.numenta.org port 8888 (tcp) failed: Connection
>> refused
>>
>> Mark
>>
>>
>> On 7 December 2013 21:40, Subutai Ahmad <[email protected]> wrote:
>>>
>>> Nice!
>>>
>>> --Subutai
>>>
>>>
>>> On Sat, Dec 7, 2013 at 10:20 AM, Erik Blas <[email protected]> wrote:
>>>>
>>>> It's alive!
>>>>
>>>> Good stuff Matt, thanks!
>>>>
>>>>
>>>> On Fri, Dec 6, 2013 at 10:25 PM, Matthew Taylor <[email protected]>
>>>> wrote:
>>>>>
>>>>> I forgot to open up port 8888 in the AWS security group. Should work
>>>>> now.
>>>>>
>>>>> Thanks,
>>>>>
>>>>> ---------
>>>>> Matt Taylor
>>>>> OS Community Flag-Bearer
>>>>> Numenta
>>>>>
>>>>>
>>>>> On Fri, Dec 6, 2013 at 9:21 PM, Erik Blas <[email protected]> wrote:
>>>>>>
>>>>>> It's dead, Jim.
>>>>>>
>>>>>> I can't reach it either.
>>>>>>
>>>>>>
>>>>>> On Fri, Dec 6, 2013 at 8:30 PM, Matthew Taylor <[email protected]>
>>>>>> wrote:
>>>>>>>
>>>>>>> Really? http://issues.numenta.org:8888/ works for me...
>>>>>>>
>>>>>>> ---------
>>>>>>> Matt Taylor
>>>>>>> OS Community Flag-Bearer
>>>>>>> Numenta
>>>>>>>
>>>>>>>
>>>>>>> On Fri, Dec 6, 2013 at 5:30 PM, Ian Danforth
>>>>>>> <[email protected]> wrote:
>>>>>>>>
>>>>>>>> Still not loading for me if it's supposed to be that same link
>>>>>>>>
>>>>>>>> Ian
>>>>>>>>
>>>>>>>>
>>>>>>>> On Fri, Dec 6, 2013 at 1:31 PM, Matthew Taylor <[email protected]>
>>>>>>>> wrote:
>>>>>>>>>
>>>>>>>>> Should be up and running (and more resilient) now.
>>>>>>>>> ---------
>>>>>>>>> Matt Taylor
>>>>>>>>> OS Community Flag-Bearer
>>>>>>>>> Numenta
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On Fri, Dec 6, 2013 at 1:13 AM, Matthew Taylor <[email protected]>
>>>>>>>>> wrote:
>>>>>>>>> > The server died. I'll get something sturdier back up tomorrow.
>>>>>>>>> >
>>>>>>>>> > Matt
>>>>>>>>> >
>>>>>>>>> > Sent from my MegaPhone
>>>>>>>>> >
>>>>>>>>> > On Dec 6, 2013, at 12:44 AM, Mark Wilson <[email protected]>
>>>>>>>>> > wrote:
>>>>>>>>> >
>>>>>>>>> >
>>>>>>>>> > http://issues.numenta.org:8888/classnupic_1_1research_1_1_t_p_1_1_t_p.html
>>>>>>>>> > doesn't work for me :(
>>>>>>>>> >
>>>>>>>>> >
>>>>>>>>> > On 5 December 2013 23:41, Matthew Taylor <[email protected]>
>>>>>>>>> > wrote:
>>>>>>>>> >>
>>>>>>>>> >> 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
>>>>>>>>> >
>>>>>>>>> >
>>>>>>>>> > _______________________________________________
>>>>>>>>> > nupic mailing list
>>>>>>>>> > [email protected]
>>>>>>>>> > http://lists.numenta.org/mailman/listinfo/nupic_lists.numenta.org
>>>>>>>>>
>>>>>>>>> _______________________________________________
>>>>>>>>> nupic mailing list
>>>>>>>>> [email protected]
>>>>>>>>> http://lists.numenta.org/mailman/listinfo/nupic_lists.numenta.org
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> _______________________________________________
>>>>>>>> nupic mailing list
>>>>>>>> [email protected]
>>>>>>>> http://lists.numenta.org/mailman/listinfo/nupic_lists.numenta.org
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> _______________________________________________
>>>>>>> nupic mailing list
>>>>>>> [email protected]
>>>>>>> http://lists.numenta.org/mailman/listinfo/nupic_lists.numenta.org
>>>>>>>
>>>>>>
>>>>>>
>>>>>> _______________________________________________
>>>>>> nupic mailing list
>>>>>> [email protected]
>>>>>> http://lists.numenta.org/mailman/listinfo/nupic_lists.numenta.org
>>>>>>
>>>>>
>>>>>
>>>>> _______________________________________________
>>>>> nupic mailing list
>>>>> [email protected]
>>>>> http://lists.numenta.org/mailman/listinfo/nupic_lists.numenta.org
>>>>>
>>>>
>>>>
>>>> _______________________________________________
>>>> nupic mailing list
>>>> [email protected]
>>>> http://lists.numenta.org/mailman/listinfo/nupic_lists.numenta.org
>>>>
>>>
>>>
>>> _______________________________________________
>>> nupic mailing list
>>> [email protected]
>>> http://lists.numenta.org/mailman/listinfo/nupic_lists.numenta.org
>>>
>>
>
>
> _______________________________________________
> nupic mailing list
> [email protected]
> http://lists.numenta.org/mailman/listinfo/nupic_lists.numenta.org
>
_______________________________________________
nupic mailing list
[email protected]
http://lists.numenta.org/mailman/listinfo/nupic_lists.numenta.org
