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

[MXNet-111] Doc for gluon.data.transforms #10155

Merged
merged 4 commits into from Mar 23, 2018

Conversation

yzhliu
Copy link
Member

@yzhliu yzhliu commented Mar 19, 2018

Description

Documents for gluon.vision.transforms

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

API documents for https://mxnet.incubator.apache.org/api/python/gluon/data.html

```eval_rst
.. currentmodule:: mxnet.gluon.data.vision.transforms
```

Copy link
Contributor

Choose a reason for hiding this comment

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

add an example. Something like

from mxnet.gluon.data.vision import MNIST, transforms�
transform = transforms.Compose([
    transforms.Resize(300),
    transforms.RandomResizedCrop(224),
    transforms.RandomBrightness(0.1),
    transforms.ToTensor(),
    transforms.Normalize([0,0,0], [1,1,1])])

data = MNIST(train=True).transform_first(transform)

data_loader = gluon.data.DataLoader(
    data, batch_size=64, num_workers=4)

for data, label in data_loader:
    …�

@piiswrong
Copy link
Contributor

@yzhliu ping

@yzhliu
Copy link
Member Author

yzhliu commented Mar 22, 2018

will add today

@piiswrong piiswrong merged commit 5c7407d into apache:master Mar 23, 2018
ashokei pushed a commit to ashokei/incubator-mxnet that referenced this pull request Mar 27, 2018
* add transform section

* more examples for vision.transforms

* add overall examples for gluon.vision.transforms

* Update data.md
jinhuang415 pushed a commit to jinhuang415/incubator-mxnet that referenced this pull request Mar 30, 2018
* add transform section

* more examples for vision.transforms

* add overall examples for gluon.vision.transforms

* Update data.md
rahul003 pushed a commit to rahul003/mxnet that referenced this pull request Jun 4, 2018
* add transform section

* more examples for vision.transforms

* add overall examples for gluon.vision.transforms

* Update data.md
zheng-da pushed a commit to zheng-da/incubator-mxnet that referenced this pull request Jun 28, 2018
* add transform section

* more examples for vision.transforms

* add overall examples for gluon.vision.transforms

* Update data.md
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants