rnn_cell little bug fixed #11003

chinakook · 2018-05-20T04:00:23Z

When input is list of "NC" layout(i.e. split by time). The batch_axis should be 0.
Add HybidSequentialRNNCell, which can be nested in HybridBlock but SequentialRNNCell cannot.

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

szha · 2018-05-20T04:16:22Z

python/mxnet/gluon/rnn/rnn_cell.py

@@ -630,7 +630,7 @@ def hybrid_forward(self, F, inputs, states, i2h_weight,
        return next_h, [next_h]


-class SequentialRNNCell(RecurrentCell):
+class SequentialRNNCell(HybridRecurrentCell):


This might break existing code where the member cells are not HybridRecurrentCells. Maybe have a separate class like HybridSequentialRNNCell?

szha

Could you add tests?

szha · 2018-05-20T05:58:24Z

python/mxnet/gluon/rnn/rnn_cell.py

+        super(HybridSequentialRNNCell, self).__init__(prefix=prefix, params=params)
+
+    def hybrid_forward(self, F, x, *args, **kwargs):
+        raise NotImplementedError


HybridSequentialRNNCell should have hybrid_forward implemented similarly to SequentialRNNCell.

Sorry for the confusion. The hybrid_forward method should have the forward logic similar to what SequentialRNNCell has in its __call__

@piiswrong do you remember why SequentialRNNCell has hybrid_forward?

szha · 2018-05-20T18:39:16Z

python/mxnet/gluon/rnn/rnn_cell.py

-    def hybrid_forward(self, F, x, *args, **kwargs):
-        raise NotImplementedError
+    def hybrid_forward(self, F, *args, **kwargs):
+        super(HybridSequentialRNNCell, self).hybrid_forward(args, kwargs)


this class is an abstract base class and should not implement hybrid_forward.

szha · 2018-05-20T18:42:08Z

python/mxnet/gluon/rnn/rnn_cell.py

+        super(HybridSequentialRNNCell, self).__init__(prefix=prefix, params=params)
+
+    def hybrid_forward(self, F, x, *args, **kwargs):
+        raise NotImplementedError


Sorry for the confusion. The hybrid_forward method should have the forward logic similar to what SequentialRNNCell has in its __call__

szha · 2018-05-20T18:43:28Z

python/mxnet/gluon/rnn/rnn_cell.py

+        super(HybridSequentialRNNCell, self).__init__(prefix=prefix, params=params)
+
+    def hybrid_forward(self, F, x, *args, **kwargs):
+        raise NotImplementedError


@piiswrong do you remember why SequentialRNNCell has hybrid_forward?

szha · 2018-05-21T08:33:32Z

python/mxnet/gluon/rnn/rnn_cell.py

@@ -79,9 +79,10 @@ def _format_sequence(length, inputs, layout, merge, in_layout=None):
        assert length is None or len(inputs) == length
        if isinstance(inputs[0], symbol.Symbol):
            F = symbol
+            # TODO: batch_size cannot got here


symbol should be able to infer this just fine

szha · 2018-05-21T08:35:57Z

python/mxnet/gluon/rnn/rnn_cell.py

+        return _cells_begin_state(self._children.values(), **kwargs)
+
+    def __call__(self, inputs, states):
+        raise NotImplementedError("HybridSequentialRNN cannot be stepped. Please use unroll")


should allow forward unless bidirectional cell is registered, similar to sequential rnn cell.
a hybrid cell means that the graph inside the cell (i.e. for a single step) can be hybridized.

szha · 2018-06-18T17:24:58Z

Ping @chinakook

szha · 2018-06-26T18:49:45Z

@chinakook pinging again. It would be great if we could get this in. Would you address the review comments? Thanks.

chinakook · 2018-06-27T00:49:54Z

@szha Is that all?

szha · 2018-06-27T01:50:10Z

python/mxnet/gluon/rnn/rnn_cell.py

+        next_states = []
+        p = 0
+        for cell in self._children.values():
+            assert not isinstance(cell, BidirectionalCell)


move the assertion outside to fail fast. assert all(not isinstance(cell) for cell in ...)

also, I'd suggest including a similar error message to what SequentialRNNCell step has.

szha

@chinakook otherwise looks good to me. Thanks.

szha · 2018-06-29T00:20:16Z

@chinakook would you mind doing a rebase? we have a couple of flaky tests that are already fixed in the upstream.

chinakook · 2018-06-29T00:56:36Z

Rebasing like this? I've not very familiar with rebasing. Should I close this and open another PR?

szha · 2018-06-29T02:12:35Z

suppose you have a git remote called "upstream" (which you can get by doing git remote add upstream https://github.com/apache/incubator-mxnet), you can do git pull upstream master --rebase and then do a force push. You don't need to reopen the PR

eric-haibin-lin · 2018-06-29T15:47:21Z

tests/python/unittest/test_gluon_rnn.py

@@ -171,6 +171,54 @@ def test_stack():
    assert outs == [(10, 100), (10, 100), (10, 100)]


+def test_hybridstack():


Do we have a unit test for the NC layout bug you fixed?

szha · 2018-06-29T15:59:38Z

tests/python/unittest/test_gluon_rnn.py

+        def hybrid_forward(self, F, x):
+            return self.rnncell.unroll(3, x, layout="NTC", merge_outputs=True)
+
+    x = mx.nd.random.uniform(shape=(10, 3, 100))


@chinakook could you split this into a list to verify your fix?

szha · 2018-06-30T19:38:16Z

@chinakook thanks for the contribution. @eric-haibin-lin I will add the test.

chinakook requested a review from szha as a code owner May 20, 2018 04:00

szha reviewed May 20, 2018

View reviewed changes

szha reviewed May 21, 2018

View reviewed changes

szha requested a review from piiswrong May 21, 2018 18:43

szha requested a review from eric-haibin-lin June 18, 2018 22:40

szha reviewed Jun 27, 2018

View reviewed changes

szha approved these changes Jun 27, 2018

View reviewed changes

chinakook requested review from marcoabreu, sergeykolychev and yzhliu as code owners June 29, 2018 00:50

chinakook closed this Jun 29, 2018

chinakook force-pushed the patch-3 branch from 3aa59d8 to 2594fca Compare June 29, 2018 08:33

rnn_cell little bug fixed

81ec4ed

chinakook reopened this Jun 29, 2018

eric-haibin-lin reviewed Jun 29, 2018

View reviewed changes

szha reviewed Jun 29, 2018

View reviewed changes

szha merged commit 92900f0 into apache:master Jun 30, 2018

szha added a commit to szha/mxnet that referenced this pull request Jun 30, 2018

add test for apache#11003

ddc5187

szha mentioned this pull request Jun 30, 2018

add test for #11003 #11511

Merged

4 tasks

szha added a commit that referenced this pull request Jul 1, 2018

add test for #11003 (#11511)

cba2b03

XinYao1994 pushed a commit to XinYao1994/incubator-mxnet that referenced this pull request Aug 29, 2018

rnn_cell little bug fixed (apache#11003)

49fb717

XinYao1994 pushed a commit to XinYao1994/incubator-mxnet that referenced this pull request Aug 29, 2018

add test for apache#11003 (apache#11511)

d468dc8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rnn_cell little bug fixed #11003

rnn_cell little bug fixed #11003

chinakook commented May 20, 2018 •

edited

Loading

szha May 20, 2018

szha left a comment

szha May 20, 2018

szha May 20, 2018

szha May 20, 2018

szha May 20, 2018

szha May 20, 2018

szha May 20, 2018

szha May 21, 2018

szha May 21, 2018

szha commented Jun 18, 2018

szha commented Jun 26, 2018

chinakook commented Jun 27, 2018

szha Jun 27, 2018

szha Jun 27, 2018

szha left a comment

szha commented Jun 29, 2018

chinakook commented Jun 29, 2018 •

edited

Loading

szha commented Jun 29, 2018

eric-haibin-lin Jun 29, 2018

szha Jun 29, 2018

szha commented Jun 30, 2018

		@@ -171,6 +171,54 @@ def test_stack():
		assert outs == [(10, 100), (10, 100), (10, 100)]


		def test_hybridstack():

rnn_cell little bug fixed #11003

rnn_cell little bug fixed #11003

Conversation

chinakook commented May 20, 2018 • edited Loading

Description

Checklist

Essentials

Changes

Comments

Choose a reason for hiding this comment

szha left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szha commented Jun 18, 2018

szha commented Jun 26, 2018

chinakook commented Jun 27, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szha left a comment

Choose a reason for hiding this comment

szha commented Jun 29, 2018

chinakook commented Jun 29, 2018 • edited Loading

szha commented Jun 29, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szha commented Jun 30, 2018

chinakook commented May 20, 2018 •

edited

Loading

chinakook commented Jun 29, 2018 •

edited

Loading