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

Profile doc #10732

Merged
merged 2 commits into from
Apr 29, 2018
Merged

Profile doc #10732

merged 2 commits into from
Apr 29, 2018

Conversation

cjolivier01
Copy link
Member

Description

(Brief description on what this PR is about)

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

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here


### Profiling Objects

These profiling objects can be created and accessed from python in order to resord performance information of the python code paths
Copy link
Member

Choose a reason for hiding this comment

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

resord ?

Copy link
Member Author

Choose a reason for hiding this comment

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

changed

@cjolivier01 cjolivier01 merged commit 6bef58a into apache:master Apr 29, 2018
@cjolivier01 cjolivier01 deleted the profile_doc branch April 29, 2018 18:13
@piiswrong
Copy link
Contributor

piiswrong commented Apr 30, 2018

Needs to be listed in the index page so that it can show up
http://mxnet.incubator.apache.org/api/python/index.html

anirudh2290 pushed a commit to anirudh2290/mxnet that referenced this pull request May 7, 2018
* Profiling API docs

* Profiling API docs
rahul003 pushed a commit to rahul003/mxnet that referenced this pull request Jun 4, 2018
* Profiling API docs

* Profiling API docs
zheng-da pushed a commit to zheng-da/incubator-mxnet that referenced this pull request Jun 28, 2018
* Profiling API docs

* Profiling API docs
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.

3 participants