You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2018/10/22 23:04:32 UTC

[GitHub] aaronmarkham opened a new issue #12917: RNNCell and SequentialRNNCell functions incorrectly cross-linking in docs

aaronmarkham opened a new issue #12917: RNNCell and SequentialRNNCell functions incorrectly cross-linking in docs
URL: https://github.com/apache/incubator-mxnet/issues/12917
 
 
   ## Description
   
   Sphinx is getting confused with the multiple entries for `SequentialRNNCell` and `RNNCell`. There's one in `mxnet.gluon.rnn` and one in `mxnet.rnn`.
   https://mxnet.incubator.apache.org/api/python/symbol/rnn.html?highlight=fusedrnncell.unfuse#mxnet.rnn.FusedRNNCell.unfuse
   I think there's a question as to which `SequentialRNNCell` is being referred to here.
   And for `rnn.save_rnn_checkpoint` as to which `RNNCell` it refers to. 
   
   https://mxnet.incubator.apache.org/api/python/symbol/rnn.html?highlight=rnn.save_rnn_checkpoint#mxnet.rnn.save_rnn_checkpoint
   
   Similar to the issue with NDArray and optimizer: #12829 or the IO API: https://github.com/apache/incubator-mxnet/issues/12854
   
   Can this be fixed by something like #12886 ?
   Or maybe being specific like in this PR: https://github.com/apache/incubator-mxnet/pull/12871 ?
   
   Errors:
   ```
   /home/ubuntu/incubator-mxnet/python/mxnet/rnn/rnn_cell.py:docstring of mxnet.rnn.FusedRNNCell.unfuse:None: WARNING: more than one target found for cross-reference u'SequentialRNNCell': mxnet.gluon.rnn.SequentialRNNCell, mxnet.rnn.SequentialRNNCell
   /home/ubuntu/incubator-mxnet/python/mxnet/rnn/rnn.py:docstring of mxnet.rnn.save_rnn_checkpoint:None: WARNING: more than one target found for cross-reference u'RNNCell': mxnet.rnn.RNNCell, mxnet.gluon.rnn.RNNCell
   /home/ubuntu/incubator-mxnet/python/mxnet/rnn/rnn.py:docstring of mxnet.rnn.load_rnn_checkpoint:None: WARNING: more than one target found for cross-reference u'RNNCell': mxnet.rnn.RNNCell, mxnet.gluon.rnn.RNNCell
   /home/ubuntu/incubator-mxnet/python/mxnet/rnn/rnn.py:docstring of mxnet.rnn.do_rnn_checkpoint:None: WARNING: more than one target found for cross-reference u'RNNCell': mxnet.rnn.RNNCell, mxnet.gluon.rnn.RNNCell
   ```

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services