D1vt / DLT3D

0 stars 0 forks source link

Comments on the functions #4

Closed raultron closed 5 years ago

raultron commented 5 years ago

Every function that you add to the code should have a comment stating what are you going to do with that function, the arguments, and the output. Also, if you are coding something particularly abstract you have to describe what you intend to do with that segment of code. This will make it easier for me to understand what you are doing, you can also put links and references to the papers or books where you are extracting the theory. Check these examples:

https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

Remember that at one point I will have to help you with the gradient descent and it will be very hard to do it if I don't understand what you are doing.