[GitHub] [incubator-mxnet] zachgk opened a new issue #14404: Gluon base.data_dir() being computed in docs

[GitBox <gi...@apache.org>]

zachgk opened a new issue #14404: Gluon base.data_dir() being computed in docs
URL: https://github.com/apache/incubator-mxnet/issues/14404
 
 
   In the documentation, we use base.data_dir() to refer to local directories for some functions including [the gluon vision cifar100 dataset](https://mxnet.incubator.apache.org/api/python/gluon/data.html#mxnet.gluon.data.vision.datasets.CIFAR100). However, sphinx processes it to an actual path when generating the function api reference - `/home/jenkins_slave/.mxnet/datasets/cifar100`. This could confuse users so we should switch to a different way of referencing folders as default parameters. 
   
   A quick grep has shown this problem occurs on at least:
   - https://mxnet.incubator.apache.org/api/python/gluon/data.html#module-mxnet.gluon.data.vision
   - https://mxnet.incubator.apache.org/api/python/gluon/model_zoo.html
   - https://mxnet.incubator.apache.org/api/python/contrib/text.html
   
   @mxnet-label-bot add [Docs, 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


With regards,
Apache Git Services