search

maxvanspengler / hyperbolic_learning_library

An extension of the PyTorch library containing various tools for performing deep learning in hyperbolic space.
MIT License
134 stars 9 forks source link

Add simple docs #14

Closed philippmwirth closed 1 year ago

philippmwirth commented 1 year ago

Add simple docs

Adds a basic version of the docs covering

Note: Tutorials in the tutorials/ directory will automatically be included.

Note: The autogenerated docs do not yet work perfectly for classes. This has to be resolved in a follow-up pull-request.

Zipped html files (open index.html to view): html.zip

maxvanspengler commented 1 year ago

I checked readthedocs and it seems like a nice solution. Their hosting service is completely free as long as we remain open source and from the tutorial it seems that all we need to do is make an account, link the repo to the account and add a short config. So I guess this is the best option for now. Agreed?

philippmwirth commented 1 year ago

I checked readthedocs and it seems like a nice solution. Their hosting service is completely free as long as we remain open source and from the tutorial it seems that all we need to do is make an account, link the repo to the account and add a short config. So I guess this is the best option for now. Agreed?

Thanks for checking it out @maxvanspengler. I think we can give it a try once the repo is open-source. Btw this pull-request is ready for review now so please take a look 🙂 You can find the html files of the current version of the docs attached in the pull-request description.

I chose to go with very minimal docs for now as we can always add more things later. The most important things are installation instructions and the tutorials in my opinion.

maxvanspengler commented 1 year ago

Looks good, thanks Philipp! I'll merge this.