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

Improve hybridblock doc #11236

Merged
merged 2 commits into from
Jun 14, 2018
Merged

Improve hybridblock doc #11236

merged 2 commits into from
Jun 14, 2018

Conversation

piiswrong
Copy link
Contributor

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

@piiswrong piiswrong requested a review from szha as a code owner June 12, 2018 00:18
@@ -105,23 +105,35 @@ Hybridize will speed up execution and save memory. If the top level layer is
not a `HybridBlock`, you can still call `.hybridize()` on it and Gluon will try
to hybridize its children layers instead.

`hybridize` also accepts many options for performance tuning. For example, you
Copy link
Member

Choose a reason for hiding this comment

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

many -> several?

Copy link
Contributor

@ThomasDelteil ThomasDelteil left a comment

Choose a reason for hiding this comment

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

@piiswrong could you review this docs update as well? https://github.com/apache/incubator-mxnet/pull/11210/files thanks!

net.hybridize(static_alloc=True, static_shape=True)
```

Please refer to [API manual](https://mxnet.incubator.apache.org/api/python/gluon/gluon.html?highlight=hybridize#mxnet.gluon.Block.hybridize)
Copy link
Contributor

Choose a reason for hiding this comment

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

to the* API manual

@@ -600,6 +605,28 @@ def _summary_hook(block, _, outputs):
class HybridBlock(Block):
"""`HybridBlock` supports forwarding with both Symbol and NDArray.

`HybridBlock` is similar to `Block`, with a few differencies::
Copy link
Contributor

Choose a reason for hiding this comment

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

differences*

model.initialize(ctx=mx.cpu(0))
model.hybridize()
model(mx.nd.zeros((10, 10), ctx=mx.cpu(0)))

Forward computation in :py:class:`HybridBlock` must be static to work with :py:class:`Symbol` s,
i.e. you cannot call :py:meth:`NDArray.asnumpy`, :py:attr:`NDArray.shape`,
:py:attr:`NDArray.dtype`, etc on tensors.
Copy link
Contributor

@ThomasDelteil ThomasDelteil Jun 12, 2018

Choose a reason for hiding this comment

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

NDArray-style indexing wouldn't work either in an HybridBlock. I think it is worth mentioning it.

@piiswrong piiswrong merged commit ee1a10f into apache:master Jun 14, 2018
anirudh2290 pushed a commit to anirudh2290/mxnet that referenced this pull request Jun 14, 2018
anirudh2290 pushed a commit to anirudh2290/mxnet that referenced this pull request Jun 14, 2018
anirudh2290 pushed a commit to anirudh2290/mxnet that referenced this pull request Jun 15, 2018
anirudh2290 pushed a commit to anirudh2290/mxnet that referenced this pull request Jun 15, 2018
anirudh2290 pushed a commit to anirudh2290/mxnet that referenced this pull request Jun 15, 2018
anirudh2290 pushed a commit that referenced this pull request Jun 15, 2018
zheng-da pushed a commit to zheng-da/incubator-mxnet that referenced this pull request Jun 28, 2018
* Improve hybridblock doc

* fix
XinYao1994 pushed a commit to XinYao1994/incubator-mxnet that referenced this pull request Aug 29, 2018
* Improve hybridblock doc

* fix
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