This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
visualization docs don't line up with tutorials usage of viz #13232
Labels
Comments
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Description
When visualization is mentioned in tutorials it is always done like
mx.viz.plotor similar. It is never done asmx.visualization. However, our API reference only hasmx.visualizationand the.viz.option isn't mentioned.We have this issue around any kind of shortcut/redirect naming throughout the project.
Sphinx is unable to use the shortcut names for some reason. It has to use the full path. I don't know if this is a configuration issue or by design.
Either way the docs should line up with usage examples. We shouldn't have tutorials that have usage that is never covered in the reference docs. We shouldn't have reference docs that don't have any usage examples.
Similar issue in ONNX: #12318
@mxnet-label-bot add [Doc]
@vdantu
The text was updated successfully, but these errors were encountered: