-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
76 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,4 +5,5 @@ | |
:hidden: | ||
../../advanced/experimental/windows | ||
troubleshooting | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Troubleshooting | ||
|
||
This article helps you to solve the installation problems of Jina. | ||
|
||
## On Linux/Mac, building wheels takes long time | ||
|
||
The normal installation of Jina takes 10 seconds. If yours takes longer than this, then it is likely you unnecessarily built wheels from scratch. | ||
|
||
Every upstream dependencies of Jina have pre-built wheels exhaustively on x86 & arm64 and on MacOS & Linux and on Python 3.7, 3.8, 3.9, including `numpy`, `protobuf`, `pyzmq`, `grpcio` etc. This means, when you install Jina, your `pip` should directly leverage the pre-built wheels instead of building them from scratch locally. For example, you should expect the install log to contain `-cp38-cp38-macosx_10_15_x86_64.whl` when installing Jina on MacOS with Python 3.8. | ||
|
||
Hence, if you found you are building wheels during installation (see an example below), then it is a sign that you are installing Jina **wrongly**. | ||
|
||
```text | ||
Collecting numpy==2.0.* | ||
Downloading numpy-2.0.18.tar.gz (801 kB) | ||
|████████████████████████████████| 801 kB 1.1 MB/s | ||
Building wheels for collected packages: numpy | ||
Building wheel for numpy (setup.py) ... done | ||
Created wheel for numpy ... numpy-2.0.18-cp38-cp38-macosx_10_15_x86_64.whl | ||
``` | ||
|
||
### Solution: update your `pip` | ||
|
||
It could be simply that your local `pip` is too old. Updating it should solve the problem. | ||
|
||
```python | ||
pip install -U pip | ||
``` | ||
|
||
### If not, then... | ||
|
||
Then you are likely installing Jina on a less-supported system/architecture. For example, on native Mac M1, or on Alpine Linux, or on Raspberry Pi 2/3 (armv6/7). | ||
|
||
## On Mac M1 | ||
|
||
Some upstream dependencies do not have pre-built wheels on M1 chip, hence you are likely to encounter some issues during the install. In this case, you need to config the dev environment using Rosetta2, including your terminal, `brew` and `python`, they must be running under Rosetta2 instead of natively on M1. | ||
|
||
````{tip} | ||
You can run the following shell scrit in the terminal to check if you are running under Rosetta2 or natively on M1. | ||
```shell | ||
sysctl -n -i sysctl.proc_translated | ||
``` | ||
Depending on the results: | ||
- `0`: for Apple silicon native process | ||
- `1`: for Rosetta2 translated process | ||
- `""`: in case the OID was not found, you are using an older mac running Catalina or something. You don't have the M1 problem in the first place. | ||
```` | ||
|
||
## On Windows with `conda` | ||
|
||
Unfortunately, `conda install` is not supported on Windows. You can either do `pip install jina` natively on Windows, or use `pip/conda install` under WSL2. |