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

Update Installation.md #1259

Merged
merged 1 commit into from
Sep 27, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ To confirm that bag-of-words retrieval is working correctly, you can run the BM2
```bash
$ python -m pyserini.search \
--topics msmarco-passage-dev-subset \
--index msmarco-passage \
--index msmarco-v1-passage\
--output run.msmarco-passage.txt \
--output-format msmarco \
--bm25
Expand Down Expand Up @@ -175,6 +175,7 @@ On a Linux system, the correct path might look something like `/usr/lib/jvm/java
Unfortunately, we are unable to offer more concrete advice since the actual path depends on your OS, which JDK you're using, and a host of other factors.
+ Windows uses GBK character encoding by default, which makes resource file reading in Anserini inconsistent with that in Linux and macOS.
To fix, manually set environment variable `set _JAVA_OPTIONS=-Dfile.encoding=UTF-8` to use `UTF-8` encoding.
+ When installing with Windows, there are times you will encounter the error. `RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd`. The solution to this is to check the version of your numpy. At the time of this writing, the latest numpy version is 1.23.2 which is incompatible with the API. We consider downgrading to `1.21.1`.This way the other dependant libraries also are compatible with the API version.
Copy link
Member

Choose a reason for hiding this comment

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

Can you offer a bit more details on what's happening here? Is this a Windows only bug?

numpy version is 1.23.2 which is incompatible with the API.

Which API?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is because of the faiss-cpu library, I believe. I have noticed this in windows only in the latest 0.17.0 build. I have a personal Linux machine in which it worked fine. I also checked it with macOS Monterrey.



## Internal Notes
Expand Down