Guidelines for adding new examples

[kausky]

So this issue gives out a template or a guide that can be followed or kept in mind when writing new examples:

• The examples should be well documented in terms that can easily be understood by people entering the field of Machine learning or have been in it for a long time.

• Make examples simple enough so the user can basically grasp what he needs to build his own full-fledged model and don't over-complicate the examples but still try to include all library functionalities related to that example.

• A little bit more can be written about parameters or functionalities which are implemented differently in mlpack than what the common notion is or which might confuse the user.

• When adding the comments and writing tutorials try to mention why you followed a particular strategy in the example and maybe mention what are the implications of the strategy that you took and what are the other ways a user can proceed with the example.

• Some examples that show things that are particularly interesting or practical can take a divergence from these guidelines and can become a bit complicated, maybe an example of such could be GANs but not limited to it.

• And please take a look at the example that exists before and try to avoid redundant examples.

And lastly, this is just a guide, not strict rules so have fun writing examples and show your creativity. :)

[shrit]

@Aakash-Kaushik Thank you for writing this, I think we can add some points about tutorials too.
It is quite straightforward to write examples. Most of the above points can be agreed on by most of us.
However, it would interesting to add some points about comments and tutorials considering each example, users would like to know why we followed this pattern in writing code 👍

[birm]

I think we should leave space for especially interesting or practical examples, even if they aren't especially simple.

[kausky]

@Aakash-Kaushik Thank you for writing this, I think we can add some points about tutorials too.
It is quite straightforward to write examples. Most of the above points can be agreed on by most of us.
However, it would interesting to add some points about comments and tutorials considering each example, users would like to know why we followed this pattern in writing code 👍

I need to think about how and what to write and then i will add it.

[kausky]

I think we should leave space for especially interesting or practical examples, even if they aren't especially simple.

Yes that is correct I will add that point too.

[kausky]

Hey @shrit, @birm give it a look now.

[zoq]

@Aakash-Kaushik Thanks for putting this together, can you run a spell checker over the text?

[kausky]

@Aakash-Kaushik Thanks for putting this together, can you run a spell checker over the text?

Edited the issue, Take a look now.

[mlpack-bot]

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions! 👍