anshuman23 / tensorflex

Tensorflow bindings for the Elixir programming language :muscle:
https://hexdocs.pm/tensorflex/Tensorflex.html
Apache License 2.0
308 stars 14 forks source link

Added documentation #26

Closed anshuman23 closed 6 years ago

anshuman23 commented 6 years ago

@josevalim I have added documentation using ExDoc. Please let me know what all changes you think are required before I merge this.

Next I will clean up the README.

josevalim commented 6 years ago

@anshuman23 we should not add the doc/ folder. Make sure it is in your .gitignore. :)

josevalim commented 6 years ago

Thanks @anshuman23! I have added some comments, some are aesthetic ones, but generally this looks great!

anshuman23 commented 6 years ago

@josevalim this is somewhat unrelated, but I had also modified the README directly to read well directly using Github markdown editor. Please let me know if you find something amiss from there as well.

josevalim commented 6 years ago

Don't forget to add doc/ to `.gitignore and remove the files from the commit before merging. :)