The Wayback Machine - https://web.archive.org/web/20201208094747/https://github.com/keras-team/keras/issues/12219
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

Convert the docstrings of examples in `examples/*` to use Markdown formatting #12219

Open
gabrieldemarmiesse opened this issue Feb 6, 2019 · 13 comments

Comments

@gabrieldemarmiesse
Copy link
Member

@gabrieldemarmiesse gabrieldemarmiesse commented Feb 6, 2019

(e.g. for links and images), because some of these examples are now being rendered in the docs.

Added by @fchollet in requests for contributions.

@gabrieldemarmiesse
Copy link
Member Author

@gabrieldemarmiesse gabrieldemarmiesse commented Feb 6, 2019

See #11758

@gabrieldemarmiesse
Copy link
Member Author

@gabrieldemarmiesse gabrieldemarmiesse commented Feb 6, 2019

Tu add an example to the docs, just modify the file keras/docs/mkdocs.yml.

@joosephook
Copy link
Contributor

@joosephook joosephook commented Feb 6, 2019

Hi! I'd like to start working on this if possible. Are there any specific guidelines on how visibility should be improved? Or should it be figured out from the two existing examples in mkdocs.yml?

@gabrieldemarmiesse
Copy link
Member Author

@gabrieldemarmiesse gabrieldemarmiesse commented Feb 7, 2019

It's just making sure that the page is rendered correctly in the docs. No need to be fancy.

Also, it is advised to do one pull request per example file. This is faster to review.

@gabrieldemarmiesse
Copy link
Member Author

@gabrieldemarmiesse gabrieldemarmiesse commented Feb 7, 2019

Pull requests for this issue should include a screenshot of the docs to facilitate the review process.

@siddsuresh97
Copy link

@siddsuresh97 siddsuresh97 commented Mar 21, 2019

@gabrieldemarmiesse Can i start working on this issue?

@hnumair
Copy link

@hnumair hnumair commented Apr 16, 2019

@gabrieldemarmiesse Why this issue is still open? I guess every file is converted for Markdown.

@gabrieldemarmiesse
Copy link
Member Author

@gabrieldemarmiesse gabrieldemarmiesse commented Apr 17, 2019

Some PRs are note merged yet. So we can't really close this issue.

This was referenced Apr 23, 2019
@marcemq
Copy link

@marcemq marcemq commented Apr 28, 2019

Hi @gabrieldemarmiesse,

building the documentation using master branch, it states that the following pages exist in the docs directory, but are not included in the "nav" configuration:

  - examples/class_activation_maps.md
  - examples/mnist_cnn.md
  - examples/mnist_dataset_api.md
  - examples/mnist_denoising_autoencoder.md
  - examples/mnist_hierarchical_rnn.md
  - examples/mnist_irnn.md
  - examples/mnist_mlp.md
  - examples/mnist_net2net.md
  - examples/mnist_siamese.md
  - examples/mnist_sklearn_wrapper.md
  - examples/mnist_swwae.md
  - examples/mnist_tfrecord.md
  - examples/mnist_transfer_cnn.md
  - examples/neural_doodle.md
  - examples/neural_style_transfer.md
  - examples/pretrained_word_embeddings.md
  - examples/reuters_mlp.md
  - examples/reuters_mlp_relu_vs_selu.md
  - examples/tensorboard_embeddings_mnist.md
  - examples/variational_autoencoder.md
  - examples/variational_autoencoder_deconv.md

I've worked on those and sent its PR(#12717 - #12763), one per example as you advised.
I hope my PRs get accepted so we can finally close this issue :)

@qwertpi
Copy link

@qwertpi qwertpi commented May 4, 2019

Is any more help needed on this or not?

@marcemq
Copy link

@marcemq marcemq commented May 7, 2019

Hi @qwertpi, I've covered all examples in examples/* directory, once the PRs get merge we can close this issue.

@PyExtreme
Copy link

@PyExtreme PyExtreme commented Sep 26, 2019

Hi @marcemq , @qwertpi , @gabrieldemarmiesse , Is this still an open issue?

I am new to open source and looking to contribute to keras

@abhinav-mangal
Copy link

@abhinav-mangal abhinav-mangal commented Jul 29, 2020

I am new to open source and would like to contribute to this code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
8 participants
You can’t perform that action at this time.