[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Gneuralnetwork] documentation

From: Jean Michel Sellier
Subject: Re: [Gneuralnetwork] documentation
Date: Sun, 20 Mar 2016 12:21:32 +0100

Hi Robert,

MANY thanks for starting to work on the tutorial! I agree with you when you say that a technical documentation is important as well, but for now I guess a non-technical one is even more urgent because it can give the opportunity to non-programmers to understand what this package is about and how to use it.

Otherwise, I'd suggest you to have a look at the documentation of Archimedes (it's another one of my GNU packages):

You will see that there is a LaTex file in the folder "doc" of the distribution tarball but also HTML and PDF online documentation. I would like to organize Gneural Network in the same way. The tutorial would be both in the "doc" folder and on the website. I will prepare a new section online as soon as the tutorial is ready.

One note though: please do not comment on the final part of the script which saves the output. I am already working on that to make it more general (and powerful). At the moment, the package takes for granted that the first neuron is the input neuron and the last neuron is the output of the network (i.e. the result to save). I am changing the situation so that, now, the first LAYER will be the input and the last layer will be the output of the network. This will make things waaay more powerful and useful!

I hope this helps and answers somehow to your comments/questions.

Thanks again for contributing to this project!


2016-03-20 11:29 GMT+01:00 Robert Masur <address@hidden>:
Hi JeanĀ  and Garvit,

I am going to have a closer look at the script you mentioned and the scripting language you included in version 0.5.0 to get a tutorial started.

Something I don't understand yet is how the documentation shall be stored. I was looking at other GNU projects documentation. Usually they either have a manual section on their GNU project site or use a separate project website including a wiki etc. It seems the most common format for documentation is a (html) website. As mentioned earlier it is the first GNU project I am contributing to. Currently I feel there is a huge lack of information about the principles how to organize a GNU project, about infrstructure (code repository, project websites etc.) I would appreciate, if you (or someone else) could bring some light into the darkness.

@Jean: Can you include a new section on the project website? What format shall the tutorial have?

Apart from the tutorial I find the technical developer documentation quite important as it could be the basis for discussions about architecture, design and implementation details that could bring the project forward.

Thanks & best regards,

Am 19.03.2016 um 11:50 schrieb Jean Michel Sellier:
ory is something on the way and it will happen soon anyway.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]