Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance tutorials by adding even more descriptive comments #21

Closed
BjoernLudwigPTB opened this issue Nov 18, 2019 · 4 comments
Closed

Enhance tutorials by adding even more descriptive comments #21

BjoernLudwigPTB opened this issue Nov 18, 2019 · 4 comments
Assignees

Comments

@BjoernLudwigPTB
Copy link
Member

The tutorials are already well documented, but we could add more comments in the code. This could help us to clarify the process and make it even easier to get started.

@bangxiangyong
Copy link
Member

bangxiangyong commented Nov 25, 2019

I'm thinking of writing some short tutorials in the readthedocs panels, examples such as :

Even more ambitious could be short tutorial videos (1-5min) can be recorded with explanations and uploaded on youtube or something.

@BjoernLudwigPTB
Copy link
Member Author

BjoernLudwigPTB commented Nov 26, 2019

So starting to work on that means as well to better structurize ReadtheDocs.org, taking https://gpytorch.readthedocs.io/en/latest/ as a best-practice example, which we could use as a template.

@BjoernLudwigPTB
Copy link
Member Author

BjoernLudwigPTB commented Nov 26, 2019

We keep tutorials and examples at one place with the code.

@BjoernLudwigPTB
Copy link
Member Author

In the meantime we added quite somewhat more text and restructured the tutorials as well as better integrated them into the docs. This should be resolved by now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants