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 2020/07/09 18:41:03 UTC

[GitHub] [incubator-mxnet] icemelon9 opened a new issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

icemelon9 opened a new issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680


   ## Description
   Gluon Block, HybridBlock, SymbolBlock has an empty doc in the API doc. For example: https://mxnet.apache.org/api/python/docs/api/gluon/block.html
   
   Their actual docs appear under `gluon.nn` domain. For example: https://mxnet.apache.org/api/python/docs/api/gluon/nn/index.html#mxnet.gluon.nn.Block
   
   @ys2843  
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] leezu commented on issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
leezu commented on issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680#issuecomment-656446448


   I suggest we focus on ensuring our users see the stable API docs, given that most users don't use MXNet 2 at this point anyways. This PR has exposed some bugs in the Sphinx setup which need to be fixed before the release; but this is an issue with the website generation script and shouldn't delay the feature development. What do you think @sandeep-krishnamurthy 


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] ys2843 removed a comment on issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
ys2843 removed a comment on issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680#issuecomment-656365907


   Investigating, this PR #18412 import the website issue. 


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] leezu commented on issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
leezu commented on issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680#issuecomment-656806613


    WARNING: autodoc: failed to import module 'executor' from module 'mxnet'; the following exception was raised:
   No module named 'scipy'
   from the log
   
   
   https://github.com/apache/incubator-mxnet/commit/b4b8b805fe94a6df905c6eae7f6c1f83cfea9b73 introduces the scipy import


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] ys2843 commented on issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
ys2843 commented on issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680#issuecomment-656365907


   Investigating, this PR #18412 import the website issue. 


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] sandeep-krishnamurthy commented on issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
sandeep-krishnamurthy commented on issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680#issuecomment-656416744


   @leezu - Should we revert the PR ( https://github.com/apache/incubator-mxnet/pull/18413 ) if we are unable to fix the broken website issue quickly. Ideally this should have been caught before the PR was merged. We shall work on it as you suggested above to have broken link checker as part of the PR build. But, given currently Python APIs are broken, I prefer we revert and merge back with the fix.
   What do you think?


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] leezu closed issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
leezu closed issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680


   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] leezu edited a comment on issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
leezu edited a comment on issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680#issuecomment-656373159


   This is as MXNet exposes `Block` as both `gluon.Block` and `gluon.nn.Block`. I'm not sure if it's intended or not. If we like to remove it, we just need to use the `__all__` specifier in `nn.__init__`.
   
   https://github.com/apache/incubator-mxnet/blob/beafba76395e75c093f99d20ac62e38f48e91012/python/mxnet/gluon/nn/__init__.py#L22
   
   Sphinx may place the doc at where-ever other Sphinx pages link from. I see that 
   
   https://github.com/apache/incubator-mxnet/blame/acf2d27efe583ceb0f6b5253f0ac78ad6bf00e8e/docs/python_docs/python/tutorials/getting-started/to-mxnet/pytorch.md#L146
   
   tutorials use the `gluon.nn.Block` name instead of `gluon.Block`. That's why Sphinx may put the doc at `gluon.nn.Block`.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] leezu edited a comment on issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
leezu edited a comment on issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680#issuecomment-656373159


   This should be due to missing use of `__all__` specifier in the `gluon.nn` namespace.
   
   https://github.com/apache/incubator-mxnet/blob/beafba76395e75c093f99d20ac62e38f48e91012/python/mxnet/gluon/nn/__init__.py#L22
   
   imports the Block etc into the gluon.nn namespace and now it might be undefined behavior if Sphinx will show the Block doc as part of gluon.nn or gluon namespace.
   
   Suggest to fix the `__all__` usage and improve the website broken link checker to avoid such bugs in the future
   
   Please see https://stackoverflow.com/questions/44834/can-someone-explain-all-in-python


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] leezu edited a comment on issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
leezu edited a comment on issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680#issuecomment-656373159


   I notice that 1.6 site displays both locations
   
   https://mxnet.apache.org/versions/1.6/api/python/docs/api/gluon/block.html#mxnet.gluon.Block
   https://mxnet.apache.org/versions/1.6/api/python/docs/api/gluon/nn/index.html#mxnet.gluon.nn.Block
   
   Maybe Sphinx get's interrupted during generating the gluon/block.html page because it contains some files with broken links: 
   For example, the following file refers to API that has been removed https://github.com/apache/incubator-mxnet/blob/243ade93bcb8b7962d1faeb89c98409e3ae0d7a4/docs/python_docs/python/api/gluon/parameter_dict.rst 
   
   Deleting this file may be sufficient for fixing the site
   
   @ys2843 can you please help make sure the broken link checker runs on every PR to avoid such issues going forward?


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] leezu edited a comment on issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
leezu edited a comment on issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680#issuecomment-656373159


   I notice that 1.6 site displays both locations
   
   https://mxnet.apache.org/versions/1.6/api/python/docs/api/gluon/block.html#mxnet.gluon.Block
   https://mxnet.apache.org/versions/1.6/api/python/docs/api/gluon/nn/index.html#mxnet.gluon.nn.Block
   
   Maybe Sphinx get's interrupted during generating the gluon/block.html page because it contains some files with broken links: 
   For example, the following file refers to API that has been removed https://github.com/apache/incubator-mxnet/blob/243ade93bcb8b7962d1faeb89c98409e3ae0d7a4/docs/python_docs/python/api/gluon/parameter_dict.rst 
   
   Deleting this file may be sufficient for fixing the site
   
   @ys2843 can you please help make sure the broken link checker runs on every PR to avoid such issues going forward? Maybe activating the `warning-is-error` in https://github.com/apache/incubator-mxnet/blob/243ade93bcb8b7962d1faeb89c98409e3ae0d7a4/docs/python_docs/python/scripts/conf.py or changing a different option would be sufficient?


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] leezu commented on issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
leezu commented on issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680#issuecomment-656373159


   This should be due to missing use of `__all__` specifier in the `gluon.nn` namespace.
   
   https://github.com/apache/incubator-mxnet/blob/beafba76395e75c093f99d20ac62e38f48e91012/python/mxnet/gluon/nn/__init__.py#L22
   
   imports the Block etc into the gluon.nn namespace and now it might be undefined behavior if Sphinx will show the Block doc as part of gluon.nn or gluon namespace.
   
   Suggest to fix the __all__ usage and improve the website broken link checker to avoid such bugs in the future
   
   Please see https://stackoverflow.com/questions/44834/can-someone-explain-all-in-python


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [incubator-mxnet] leezu edited a comment on issue #18680: [Doc] Gluon Block/HybridBlock/SymbolBlock appears at the wrong place in the API doc

Posted by GitBox <gi...@apache.org>.
leezu edited a comment on issue #18680:
URL: https://github.com/apache/incubator-mxnet/issues/18680#issuecomment-656373159


   I notice that 1.6 site displays both locations
   
   https://mxnet.apache.org/versions/1.6/api/python/docs/api/gluon/block.html#mxnet.gluon.Block
   https://mxnet.apache.org/versions/1.6/api/python/docs/api/gluon/nn/index.html#mxnet.gluon.nn.Block


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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