Displayed some examples in the docs. #11758
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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. |
kiku-jw
pushed a commit
to kiku-jw/keras
that referenced
this pull request
Mar 4, 2019
### 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:    - [ ] 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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: