dmlc / gluon-nlp

NLP made easy
https://nlp.gluon.ai/
Apache License 2.0
2.56k stars 535 forks source link

[Documentation] Broken link to Bert Fine-Tuning examples page #666

Open animohan opened 5 years ago

animohan commented 5 years ago

In the documentation here : https://github.com/dmlc/gluon-nlp/blob/master/docs/examples/sentence_embedding/bert.md in the "Conclusion" points to this broken link ( https://github.com/dmlc/gluon-nlp/blob/master/docs/model_zoo/bert/index.rst) for referencing other fine tuning scripts.

This probably needs to reference this page: - https://gluon-nlp.mxnet.io/master/model_zoo/bert/index.html

szha commented 5 years ago

@animohan thanks for raising this issue. This markdown is used to render the notebook that you can find here: http://gluon-nlp.mxnet.io/master/examples/sentence_embedding/bert.html. That's the link we originally intended for it to work.

That said, I understand that It indeed might be a bit confusing since people may read the markdown directly. I will keep this issue open for collection suggestions on how to avoid this confusion

eric-haibin-lin commented 5 years ago

@szha what about always reference to the github folder (e.g. ../../../scripts/bert), and adding a .htaccess file to our web server so that gluon-nlp.mxnet.io/scripts/bert are redirected to modelzoo/bert? We also need to make sure modelzoo/bert displays correctly (defaults to modelzoo/bert/index.html)

szha commented 5 years ago

Redirection should work, though my worry is it might be error prone. The links that include 'scripts' are currently manually replaced in the makefile.

szha commented 5 years ago

The solution to this issue is tracked in https://github.com/dmlc/gluon-nlp/issues/894.