gradhep / neos

Upstream optimisation for downstream inference
BSD 3-Clause "New" or "Revised" License
69 stars 5 forks source link

docs: Add links and pip best practices #8

Closed matthewfeickert closed 4 years ago

matthewfeickert commented 4 years ago

Add links to the README for fax and the demo_training notebook. Additionally use python -m pip for best practice.

matthewfeickert commented 4 years ago

Thanks for the edits to the README -- I'll make the appropriate changes

I think that it is best to keep things PR focused, so it would be better to rebase the PR and resolve the issues there then to just add them in on master. @phinate If you don't have conerns here, I can do the rebasing to fix this up — I will need to edit master though.

phinate commented 4 years ago

Thanks for the edits to the README -- I'll make the appropriate changes

I think that it is best to keep things PR focused, so it would be better to rebase the PR and resolve the issues there then to just add them in on master. @phinate If you don't have conerns here, I can do the rebasing to fix this up — I will need to edit master though.

That sounds like a much better idea, thanks :)

matthewfeickert commented 4 years ago

@phinate This should be good to go now. You're going to want to do the following though locally first as we reworte history a bit on master (which is probably obvious to you):

$ git checkout master
$ git reset --hard origin/master

Also, I apologize if my suggestions came across as pushy or trying to tell you what to do. This is your project and original awesome work. So feel free to let me know (or have @lukasheinrich gently remind me :slightly_smiling_face:) if I ever come across as too opinionated or pushy.