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

Fix READMEs for examples #14179

Merged
merged 9 commits into from
Feb 19, 2019
Merged

Conversation

NRauschmayr
Copy link
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
Copy link
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.

@eric-haibin-lin
Copy link
Member

sparse changes looks good to me

Copy link
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.

example/gan/CGAN_mnist_R/README.md Outdated Show resolved Hide resolved

## 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
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

example/gluon/actor_critic/README.md Outdated Show resolved Hide resolved

For training:

- Arguments
Copy link
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

example/gluon/lstm_crf/README.md Outdated Show resolved Hide resolved
example/gluon/mnist/README.md Outdated Show resolved Hide resolved
example/gluon/mnist/README.md Show resolved Hide resolved
example/gluon/super_resolution/README.md Show resolved Hide resolved
example/sparse/README.md Outdated Show resolved Hide resolved
@ankkhedia
Copy link
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
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
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
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
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
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)

example/gluon/audio/README.md Outdated Show resolved Hide resolved
example/gluon/house_prices/README.md Outdated Show resolved Hide resolved
@ThomasDelteil ThomasDelteil merged commit b396a63 into apache:master Feb 19, 2019
jessr92 pushed a commit to jessr92/incubator-mxnet that referenced this pull request Feb 28, 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
jessr92 pushed a commit to jessr92/incubator-mxnet that referenced this pull request Feb 28, 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
jessr92 pushed a commit to jessr92/incubator-mxnet that referenced this pull request Feb 28, 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
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