allenai / deep_qa

A deep NLP library, based on Keras / tf, focused on question answering (but useful for other NLP too)
Apache License 2.0
404 stars 132 forks source link

Why ReadMe.md haven't mention the doc's url and No install instructions? #280

Closed liyi193328 closed 7 years ago

liyi193328 commented 7 years ago

Hi, as the title. I know the doc url is http://deep-qa.readthedocs.io/en/latest/models/about_models.html, but I suggest place it in the ReadMe. To use the liabrary , I must add project path to PYTHONPATH manully?

matt-gardner commented 7 years ago

Thanks, that's a good suggestion. You can get to the docs by clicking on the docs badge at the top, but a more explicit link would be a good idea. Care to submit a PR to add one?

As for installing this, we've started the process to get this on pip, but haven't quite thought this is totally ready for a public release yet, so we haven't actually done it, or announced this project anywhere. So, yes, you'll need to put this on your PYTHONPATH somehow for now.