keras-team / keras

Deep Learning for humans
http://keras.io/
Apache License 2.0
61.86k stars 19.44k forks source link

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

Closed gabrieldemarmiesse closed 3 years ago

gabrieldemarmiesse commented 5 years ago

(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 commented 5 years ago

See #11758

gabrieldemarmiesse commented 5 years ago

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

joosephook commented 5 years ago

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 commented 5 years ago

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 commented 5 years ago

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

siddsuresh97 commented 5 years ago

@gabrieldemarmiesse Can i start working on this issue?

hnumair commented 5 years ago

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

gabrieldemarmiesse commented 5 years ago

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

marcemq commented 5 years ago

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 commented 5 years ago

Is any more help needed on this or not?

marcemq commented 5 years ago

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

PyExtreme commented 5 years ago

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

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

abhinav-mangal commented 4 years ago

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

amansaini01 commented 3 years ago

hello, I am new to open source and wants to learn and contribute, is this open?