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

[DOC] Refine documentation of runtime feature detection #14238

Merged
merged 5 commits into from
Mar 5, 2019
Merged

[DOC] Refine documentation of runtime feature detection #14238

merged 5 commits into from
Mar 5, 2019

Conversation

larroy
Copy link
Contributor

@larroy larroy commented Feb 22, 2019

Description

This refines the documentation of the Python API.

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:https://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

@larroy larroy requested a review from szha as a code owner February 22, 2019 21:50
@larroy
Copy link
Contributor Author

larroy commented Feb 22, 2019

@aaronmarkham

@larroy larroy changed the title [Doc] Refine documentation of runtime feature detection [DOC] Refine documentation of runtime feature detection Feb 22, 2019
@roywei
Copy link
Member

roywei commented Feb 23, 2019

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

@marcoabreu marcoabreu added Doc pr-awaiting-review PR is waiting for code review labels Feb 23, 2019
roywei
roywei approved these changes Feb 23, 2019
View reviewed changes
Copy link
Member

@roywei roywei 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!

aaronmarkham
aaronmarkham reviewed Feb 25, 2019
View reviewed changes
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.

Can you provide example usage for .Feature and .feature_list()?
A minor suggestion is to consistently use periods at the ends of each sentence - specifically for description text.

python/mxnet/runtime.py Outdated Show resolved Hide resolved
python/mxnet/runtime.py Outdated Show resolved Hide resolved
python/mxnet/runtime.py Show resolved Hide resolved
@aaronmarkham
Copy link
Contributor

One other thing - I couldn't find how to navigate to this API. I had to search for it.
It would make sense to have it listed here:
http:https://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-14238/2/api/python/index.html#tools

@larroy
Copy link
Contributor Author

larroy commented Feb 27, 2019

@aaronmarkham There's a link in the page you showed: "Run-Time Feature detection / Library Info
Run-Time Feature detection / Library info
"

vandanavk
vandanavk approved these changes Mar 4, 2019
View reviewed changes
Copy link
Contributor

@vandanavk vandanavk left a comment

Choose a reason for hiding this comment

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

LGTM

@vandanavk
Copy link
Contributor

@aaronmarkham is this PR good to go?

@szha szha merged commit 434726e into apache:master Mar 5, 2019
vdantu pushed a commit to vdantu/incubator-mxnet that referenced this pull request Mar 31, 2019
@larroy @vdantu
[DOC] Refine documentation of runtime feature detection (apache#14238)
1e08446 
* minor: Refine documentation

* Update python/mxnet/runtime.py

Co-Authored-By: larroy <[email protected]>

* Update python/mxnet/runtime.py

Co-Authored-By: larroy <[email protected]>

* Address CR comment

* retrigger CI
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
@larroy
[DOC] Refine documentation of runtime feature detection (apache#14238)
131ff05 
* minor: Refine documentation

* Update python/mxnet/runtime.py

Co-Authored-By: larroy <[email protected]>

* Update python/mxnet/runtime.py

Co-Authored-By: larroy <[email protected]>

* Address CR comment

* retrigger CI
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@aaronmarkham aaronmarkham aaronmarkham approved these changes

@roywei roywei roywei approved these changes

@vandanavk vandanavk vandanavk approved these changes

@szha szha Awaiting requested review from szha szha is a code owner

Assignees
No one assigned
Labels
Doc pr-awaiting-review PR is waiting for code review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@larroy @roywei @aaronmarkham @vandanavk @szha @marcoabreu