-
Notifications
You must be signed in to change notification settings - Fork 6.8k
Add API documentation for upsampling operator with examples #14919
Add API documentation for upsampling operator with examples #14919
Conversation
@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? |
There was a problem hiding this 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.
Co-Authored-By: Aaron Markham <markhama@amazon.com>
Co-Authored-By: Aaron Markham <markhama@amazon.com>
Co-Authored-By: Aaron Markham <markhama@amazon.com>
Makes sense, will make it pseudocode. Other comments addressed. Thanks. |
@aaronmarkham - Addressed the comments, made it pseudocode. |
…4919) * Add API documentation for upsampling operator with examples * Update src/operator/nn/upsampling.cc Co-Authored-By: Aaron Markham <markhama@amazon.com> * Update src/operator/nn/upsampling.cc Co-Authored-By: Aaron Markham <markhama@amazon.com> * Update src/operator/nn/upsampling.cc Co-Authored-By: Aaron Markham <markhama@amazon.com> * Make API doc example as pseudocode than code
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
@aaronmarkham @vandanavk - Can you please help review this?