Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some readme edits #13

Merged
merged 4 commits into from
May 1, 2020
Merged

Some readme edits #13

merged 4 commits into from
May 1, 2020

Conversation

nikhilro
Copy link
Member

No description provided.

@nikhilro nikhilro requested a review from daemon April 29, 2020 15:43
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@nikhilro
Copy link
Member Author

(1) just using pygaggle, in which case pip is sufficient, and (2) developing/evaluating, in which we need to clone the entire repo

@rodrigonogueira4 @lintool do you guys think this helps distinguish between the two?

@rodrigonogueira4
Copy link
Member

(1) just using pygaggle, in which case pip is sufficient, and (2) developing/evaluating, in which we need to clone the entire repo

@rodrigonogueira4 @lintool do you guys think this helps distinguish between the two?

I think the installation instructions should be kept the same as before, i.e., pip install pygaggle, install torch, Download the index, etc...
Then, inside the section "## Running rerankers on CovidQA", we add the following instruction: "Before running these evaluations, you need to clone this repo git clone ...".

@nikhilro
Copy link
Member Author

Ah okay, I guess those are needed even if you don't intend to run the evaluations. Sorry I have no clue about this...Will change

Copy link
Member

@rodrigonogueira4 rodrigonogueira4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! thanks a lot for improving this!

@nikhilro nikhilro merged commit 18f848a into master May 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants