Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Nov 17, 2023. It is now read-only.

Fix READMEs for examples#14179

Merged
ThomasDelteil merged 9 commits into
apache:masterfrom
NRauschmayr:fix_examples
Feb 19, 2019
Merged

Fix READMEs for examples#14179
ThomasDelteil merged 9 commits into
apache:masterfrom
NRauschmayr:fix_examples

Conversation

@NRauschmayr
Copy link
Copy Markdown
Contributor

Description

Some examples did not have READMEs or they were in the wrong folder. The README for CGAN-R example was taken from here http://dmlc.ml/rstats/2017/06/01/Generative-Adversarial-Network-in-R.html
I also fixed the mxnet_captcha.R example ( followup from https://discuss.mxnet.io/t/error-in-output-shape-output-names-dim-x-value-label-attempt-to-select-less-than-one-element-in-oneindex/3172/5)

fixing examples and adding READMEs

fixing examples and adding READMEs

fixing examples and adding READMEs

add missing files

fixed some bugs in readmes

fixed some bugs in readmes

fixed some spelling mistakes

update

update
@NRauschmayr NRauschmayr requested a review from szha as a code owner February 15, 2019 17:27
@szha szha requested a review from hetong007 February 15, 2019 17:55
Copy link
Copy Markdown
Member

@szha szha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gluon changes look good to me.

@szha szha requested a review from eric-haibin-lin February 15, 2019 17:59
@eric-haibin-lin
Copy link
Copy Markdown
Member

sparse changes looks good to me

Copy link
Copy Markdown
Contributor

@ThomasDelteil ThomasDelteil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work, really help bringing the quality of our examples up. Minor comments and also we usually store images on dmlc/web-data to avoid bloating the mxnet repo with a lot of images.

Comment thread example/gan/CGAN_mnist_R/README.md Outdated
Comment thread example/gan/CGAN_mnist_R/README.md Outdated

## Data preperation

The MNIST dataset is available on Kaggle. Once train.csv is downloaded into the data/ folder, we can import into R.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the link

Comment thread example/gluon/actor_critic/README.md Outdated

For training:

- Arguments
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a train.py -h that can output a standardized helper output? If not maybe it would be good to add the comments you made straight in the code

Comment thread example/gluon/lstm_crf/README.md Outdated
Comment thread example/gluon/mnist/README.md Outdated
Comment thread example/gluon/mnist/README.md
Comment thread example/gluon/super_resolution/README.md
Comment thread example/sparse/README.md Outdated
@ankkhedia
Copy link
Copy Markdown
Contributor

@NRauschmayr Thanks for the contribution!
@mxnet-label-bot add [pr-awaiting-review, Example]

@marcoabreu marcoabreu added Example pr-awaiting-review PR is waiting for code review labels Feb 15, 2019
Copy link
Copy Markdown
Contributor

@ankkhedia ankkhedia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a minor comment


2. Download the dataset(train.zip, test.zip) required for this example from the location:
https://drive.google.com/drive/folders/0By0bAi7hOBAFUHVXd1JCN3MwTEU

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this dataset be added to the some mxnet related S3 bucket rather than a private google drive?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with you. We need to figure out what the license of the dataset is. I assume the original files are from here https://datahack.analyticsvidhya.com/contest/practice-problem-urban-sound-classification/#data_dictionary
And the Google drive link belongs to someone from analyticsvidhya, so maybe this link is the official source?

Copy link
Copy Markdown
Contributor

@ThomasDelteil ThomasDelteil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

Copy link
Copy Markdown
Contributor

@ChaiBapchya ChaiBapchya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for your contribution! (Minor nitpicks)

Comment thread example/gluon/audio/README.md Outdated
Comment thread example/gluon/house_prices/README.md Outdated
@ThomasDelteil ThomasDelteil merged commit b396a63 into apache:master Feb 19, 2019
drivanov pushed a commit to drivanov/incubator-mxnet that referenced this pull request Mar 4, 2019
* fixing examples

* fixing examples and adding READMEs

fixing examples and adding READMEs

fixing examples and adding READMEs

fixing examples and adding READMEs

add missing files

fixed some bugs in readmes

fixed some bugs in readmes

fixed some spelling mistakes

update

update

* removing images and fixing spelling mistakes

* removing images and fixing spelling mistakes

* updating links

* Adding license header

* empty commit

* Add missing license headers

* Adding changes requested by ChaiBapchya
vdantu pushed a commit to vdantu/incubator-mxnet that referenced this pull request Mar 31, 2019
* fixing examples

* fixing examples and adding READMEs

fixing examples and adding READMEs

fixing examples and adding READMEs

fixing examples and adding READMEs

add missing files

fixed some bugs in readmes

fixed some bugs in readmes

fixed some spelling mistakes

update

update

* removing images and fixing spelling mistakes

* removing images and fixing spelling mistakes

* updating links

* Adding license header

* empty commit

* Add missing license headers

* Adding changes requested by ChaiBapchya
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
* fixing examples

* fixing examples and adding READMEs

fixing examples and adding READMEs

fixing examples and adding READMEs

fixing examples and adding READMEs

add missing files

fixed some bugs in readmes

fixed some bugs in readmes

fixed some spelling mistakes

update

update

* removing images and fixing spelling mistakes

* removing images and fixing spelling mistakes

* updating links

* Adding license header

* empty commit

* Add missing license headers

* Adding changes requested by ChaiBapchya
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Example pr-awaiting-review PR is waiting for code review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants