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

Add API documentation for upsampling operator with examples #14919

Merged

Conversation

sandeep-krishnamurthy
Copy link
Contributor

Description

Fixes #12970
Upsampling operator did not had valid documentation and example usage leading to issues like - #12970

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

Changes

  • Add clear API documentation for upsampling operator

@aaronmarkham @vandanavk - Can you please help review this?

@vandanavk
Copy link
Contributor

@mxnet-label-bot add [pr-awaiting-review, Doc]

@sandeep-krishnamurthy LGTM. Could you add a link to the preview of the webpage once CI passes?

@marcoabreu marcoabreu added Doc pr-awaiting-review PR is waiting for code review labels May 8, 2019
Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

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

A couple of suggestions.
Also, in another PR is was suggested by @eric-haibin-lin that the Python examples be placed in a special docs generator class, and the C example be left as pseudo-code.

src/operator/nn/upsampling.cc Outdated Show resolved Hide resolved
src/operator/nn/upsampling.cc Outdated Show resolved Hide resolved
src/operator/nn/upsampling.cc Outdated Show resolved Hide resolved
@sandeep-krishnamurthy
Copy link
Contributor Author

A couple of suggestions.
Also, in another PR is was suggested by @eric-haibin-lin that the Python examples be placed in a special docs generator class, and the C example be left as pseudo-code.

Makes sense, will make it pseudocode. Other comments addressed. Thanks.

@sandeep-krishnamurthy
Copy link
Contributor Author

@aaronmarkham - Addressed the comments, made it pseudocode.

@sandeep-krishnamurthy sandeep-krishnamurthy merged commit 874fb89 into apache:master May 9, 2019
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
…4919)

* Add API documentation for upsampling operator with examples

* Update src/operator/nn/upsampling.cc

Co-Authored-By: Aaron Markham <[email protected]>

* Update src/operator/nn/upsampling.cc

Co-Authored-By: Aaron Markham <[email protected]>

* Update src/operator/nn/upsampling.cc

Co-Authored-By: Aaron Markham <[email protected]>

* Make API doc example as pseudocode than code
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Doc pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bilinear UpSampling is broken
4 participants