Improve Readme

[TarunTomar122]

We need to write and link every algorithm and function implemented in our library in the readme. Currently, there is no way to know what functions and algorithms have been implemented, so it is very hard for newcomers to understand the repository. We want to fix that by providing links in the Readme to all the functions and algorithms that are currently implemented :)

[GoldExplosion]

hi @TarunTomar122 , i would like to take this issue :) can you specify what you mean by write and link? like give it a title and link it to website or web page where the algorithm is explained?

[rohansingh9001]

@GoldExplosion I think it just means take a table of all algorithms implemented currently. You might have to go through the code in order to do so. Also before you submit a PR, make sure that you explain the changes you are going to add incase we might need a different format.

[GoldExplosion]

@rohansingh9001, ok I think I have a general idea. Thx

[GoldExplosion]

@TarunTomar122 , i did the issue and i have created a pull request.

[KerinPithawala]

Can I work on this?

[kwanit1142]

I would like to suggest about the table in readme section, It would be great not to put all things in single table instead split them according to their categories they are allotted to like separate table for activation, another table for loss function, etc. Also, Implemented Examples should be mentioned alongside their respective models, in the Table

[TarunTomar122]

I think @kwanit1142 can guide @Kerveyfelix on what to work on for this issue. You two may start now :)

[kwanit1142]

@TarunTomar122 give it to @Kerveyfelix

[kwanit1142]

Only formatting is required for splitting tables, corresponding to categories.

[TarunTomar122]

@Kerveyfelix keep us updated on how you are going to improvise the tables

[agrawalshubham01]

@TarunTomar122 @kwanit1142, i guess it would be better to write comment at the starting of the file something like

'''

Contains
========
Relu,
LeakyRelu,
Softmax,
and so on
'''

# than all the required imports 

__all__ = ['Relu','LeakyRelu', 'Softmax','and so on']

This would reduce messiness of the initial readme file and in future if required we can add wiki to the pages to this. I guess it would be hard to maintain as we are currently maintaining.

[kwanit1142]

@TarunTomar122 @rohansingh9001 Give your insights too about this.

[TarunTomar122]

@agrawalshubham01 I think you are right.. So shall we close this issue and open another one for that?

[agrawalshubham01]

@TarunTomar122 That would be much better, we currently do not have__init__.py files after this we can implement that as well.

[GoldExplosion]

I would like to suggest about the table in readme section, It would be great not to put all things in single table instead split them according to their categories they are allotted to like separate table for activation, another table for loss function, etc. Also, Implemented Examples should be mentioned alongside their respective models, in the Table

i would like to give it a try

[kwanit1142]

(@GoldExplosion) Sure, just have a look on above mentioned insights and suggestions. In addition to that, You can coordinate with @Kerveyfelix too, on improvisation.

[GoldExplosion]

Ok got it