[mlpack] Interested in writing documentation for Mlpack's ann module

[Marcus Edel]

Hello Abhinav,

I think it would be a good idea, to include some examples and to explain the
examples step by step; probably with some sort of background information about
the model and the dataset used. Maybe we can come up with some neat images, for
the dataset. If you like, you can start with that, don't feel obligated to do
so. Also, if you don't like the idea, that's also fine, in this case, we can
come up with other ideas.

Also, I'm not sure we should use the thyroid dataset for the examples, it's kind
of an uninteresting dataset, don't you think? Don't get me wrong, the dataset is
great and important, but maybe we can find something fancy.

Thanks,
Marcus

> On 07 Apr 2016, at 08:09, Abhinav Gupta <abhinavgupta440 at gmail.com> wrote:
> 
> Hii Marcus,
>    Sure I would love to collaborate with you. I'hv started going through amf's documentation.
> 
> I'hv successfully run the test cases as independent examples like I mentioned in the issue: https://github.com/mlpack/mlpack/issues/562 <https://github.com/mlpack/mlpack/issues/562> If you like we can include those, or come up with more different examples.
> 
> Please let me know the procedure you would like me to follow, to collaborate in an efficient manner.
> 
> Thanks,
> Abhinav
> 
> 
> On Wed, Apr 6, 2016 at 3:57 AM, Marcus Edel <marcus.edel at fu-berlin.de <mailto:marcus.edel at fu-berlin.de>> wrote:
> Hello Abhinav,
> 
> sorry for the slow response. We think that the best documentation is written by
> the person who wrote the code. That doesn't mean, we don't appreciate any help
> with the documentation. I guess the person who wrote the code, has a different
> view on what might be helpful and what is trivial as another user. So, if you
> like we can combine both views and write a strong documentation, what do you
> think?
> 
> The documentation should be based on the already existing tutorials, you could
> take a look at the amf tutorial. I think, it would be nice to include some neat
> examples.
> 
> Thanks,
> Marcus
> 
> > On 03 Apr 2016, at 09:11, Abhinav Gupta <abhinavgupta440 at gmail.com <mailto:abhinavgupta440 at gmail.com>> wrote:
> >
> > Hi Ryan, Marcus ,
> >      I'm interested in writing a basic documentation on how to use mlpack to build neural networks along with few basic examples (derived mostly from the test cases). If someone is already working on this I would love to collaborate with him/her.
> > Also is there any standard procedure that you would like me to follow ?
> >
> > Thanks,
> > Abhinav
> 
> 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mailman.cc.gatech.edu/pipermail/mlpack/attachments/20160409/43d3a6c9/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 5233 bytes
Desc: not available
URL: <https://mailman.cc.gatech.edu/pipermail/mlpack/attachments/20160409/43d3a6c9/attachment.bin>