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
Displayed some examples in the docs. #11758
Displayed some examples in the docs. #11758
Conversation
Featuring more examples and tutorials on the docs website is a great idea! I'm thinking we might want to editorialize them a bit first to make them more readable (more tutorial-like). I'll be away at NeurIPS for the week but I'll start reviewing more PRs after I'm back. |
Could you fix the conflicts? Other than that LGTM |
Thanks a lot @Dref360 for taking a look at it. Github should really send emails when there are conflicts. Let me fix it right now. |
@Dref360 Should be good to go. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM Thanks
### Summary The keras examples are great, but do not benefit from a good visibility. I believe we could add them to the docs. It requires very little work since all the code and docstrings have already been written. ### Related Issues ### PR Overview There is some black magic at work with `compile`. I took the code from https://gist.github.com/rduplain/1249199 We can control which files get displayed with `mkdocs.yml`. For the moment only two are displayed. Here is the result: ![1](https://user-images.githubusercontent.com/12891691/49258375-88c73200-f435-11e8-8dc9-95c4201bfcbe.png) ![2](https://user-images.githubusercontent.com/12891691/49258377-8a90f580-f435-11e8-81f0-d6fa42df09a9.png) ![3](https://user-images.githubusercontent.com/12891691/49258378-8bc22280-f435-11e8-98d4-df9e6b677aa0.png) - [ ] This PR requires new unit tests [y/n] (make sure tests are included) - [ ] This PR requires to update the documentation [y/n] (make sure the docs are up-to-date) - [x] This PR is backwards compatible [y/n] - [ ] This PR changes the current API [y/n] (all API changes need to be approved by fchollet)
Summary
The keras examples are great, but do not benefit from a good visibility. I believe we could add them to the docs. It requires very little work since all the code and docstrings have already been written.
Related Issues
PR Overview
There is some black magic at work with
compile
. I took the code from https://gist.github.com/rduplain/1249199We can control which files get displayed with
mkdocs.yml
. For the moment only two are displayed. Here is the result: