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

Add imresize to mxnet.image documentation #12831

Closed
wants to merge 2 commits into from

Conversation

anirudhacharya
Copy link
Member

@anirudhacharya anirudhacharya commented Oct 16, 2018

Description

Though mx.image.imresize is currently available for external use, it does not show up in the docs because it was hidden behind an internal function call.

Fixes #13090

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

  • imresize

tests/python/unittest/test_image.py Outdated Show resolved Hide resolved
tests/python/unittest/test_image.py Show resolved Hide resolved
tests/python/unittest/test_image.py Show resolved Hide resolved
@Roshrini
Copy link
Member

@mxnet-label-bot [Python, pr-awaiting-response]

@marcoabreu marcoabreu added pr-awaiting-response PR is reviewed and waiting for contributor to respond Python labels Oct 16, 2018
@anirudhacharya anirudhacharya force-pushed the resizeDocs branch 6 times, most recently from 58e632d to a35fcc4 Compare October 18, 2018 18:16
python/mxnet/image/image.py Outdated Show resolved Hide resolved
@anirudhacharya anirudhacharya force-pushed the resizeDocs branch 3 times, most recently from f7859ed to 00ca107 Compare October 19, 2018 21:41
@ankkhedia
Copy link
Contributor

@nswamy @marcoabreu It seems that your review comments has been addressed. Could you please look into the PR again?

@ankkhedia
Copy link
Contributor

ping @marcoabreu @nswamy for review/merge

@aaronmarkham
Copy link
Contributor

This is great. What about adding the other OpenCV functions too?
I see copyMakeBorder is also coming from OpenCV, but if you search for that on the site you get nothing:
https://mxnet.incubator.apache.org/search.html?q=copyMakeBorder&check_keywords=yes&area=default

@anirudhacharya
Copy link
Member Author

@aaronmarkham its coming up, along with a few other additions to gluon.transforms.

python/mxnet/image/image.py Show resolved Hide resolved
python/mxnet/image/image.py Show resolved Hide resolved
python/mxnet/image/image.py Show resolved Hide resolved
new_w = np.random.randint(1, 1000)
for interp in range(0, 2):
cv_resized = cv2.resize(cv_img, (new_w, new_h), interpolation=interp)
mx_resized = mx.image.imresize(mx_img, new_w, new_h, interp)
Copy link
Contributor

Choose a reason for hiding this comment

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

can we have a test with passing out parameter?

Copy link
Member Author

Choose a reason for hiding this comment

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

i can add that test.

@kalyc
Copy link
Contributor

kalyc commented Nov 12, 2018

@anirudhacharya could you please address the comments above?

@anirudhacharya
Copy link
Member Author

i will reopen once i add the test case.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr-awaiting-response PR is reviewed and waiting for contributor to respond Python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Python API docs don't mention image.imread
8 participants