apache / mxnet

Lightweight, Portable, Flexible Distributed/Mobile Deep Learning with Dynamic, Mutation-aware Dataflow Dep Scheduler; for Python, R, Julia, Scala, Go, Javascript and more
https://mxnet.apache.org
Apache License 2.0
20.79k stars 6.79k forks source link

Gluon base.data_dir() being computed in docs #14404

Open zachgk opened 5 years ago

zachgk commented 5 years ago

In the documentation, we use base.data_dir() to refer to local directories for some functions including the gluon vision cifar100 dataset. 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:

mxnet-label-bot commented 5 years ago

Hey, this is the MXNet Label Bot. Thank you for submitting the issue! I will try and suggest some labels so that the appropriate MXNet community members can help resolve it. Here are my recommended labels: Gluon, Doc

zachgk commented 5 years ago

@mxnet-label-bot add [Doc, Python]