Skip to content

Commit ca31612

Browse files
committed
update: README updated for macos
1 parent 9cca1e9 commit ca31612

1 file changed

Lines changed: 56 additions & 12 deletions

File tree

README.md

Lines changed: 56 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,30 @@
1-
## dlib linux python wheels
1+
## dlib python wheels
22

3-
prebuilt python wheels for dlib on linux. fast installs, zero drama.
3+
prebuilt python wheels for dlib on linux and macOS. fast installs, zero drama.
44

55
### what is dlib
66

77
dlib is a modern c++ toolkit with machine learning and computer vision tools. python bindings let you use it without touching c++.
88

99
### supported platforms
1010

11-
- **architectures**: x86_64, aarch64
12-
- **python versions**: 3.11 to 3.14
13-
- **os**: linux
11+
#### linux
12+
13+
- **architectures**: x86_64, aarch64
14+
- **python versions**: 3.11 to 3.14
15+
16+
#### macOS
17+
18+
- **architectures**: x86_64 (Intel), arm64 (Apple Silicon)
19+
- **python versions**: 3.10 to 3.13
20+
- **macOS versions**: 10.9+ (Intel), 11.0+ (Apple Silicon)
1421

1522
### quick start
1623

1724
download a wheel from releases and install with pip:
1825

26+
#### linux
27+
1928
```bash
2029
# python 3.11 x86_64
2130
pip install dlib-19.24-cp311-cp311-linux_x86_64.whl
@@ -25,14 +34,30 @@ pip install dlib-19.24-cp312-cp312-linux_aarch64.whl
2534

2635
# python 3.13 x86_64
2736
pip install dlib-19.24-cp313-cp313-linux_x86_64.whl
28-
````
37+
```
38+
39+
#### macOS
40+
41+
```bash
42+
# python 3.12 intel mac
43+
pip install dlib-19.24-cp312-cp312-macosx_10_9_x86_64.whl
44+
45+
# python 3.12 apple silicon
46+
pip install dlib-19.24-cp312-cp312-macosx_11_0_arm64.whl
47+
```
2948

3049
install directly from a release url:
3150

3251
```bash
3352
pip install https://github.com/comethrusws/Dlib_linux_python_3.x/releases/download/manual-1/dlib-20.0.99-cp310-cp310-manylinux_2_39_x86_64.whl
3453
```
3554

55+
automated installer (macOS):
56+
57+
```bash
58+
curl -sSL https://raw.githubusercontent.com/comethrusws/Dlib_linux_python_3.x/main/scripts/install_wheel_macos.sh | bash
59+
```
60+
3661
### system requirements
3762

3863
install runtime deps before installing the wheel.
@@ -56,6 +81,18 @@ sudo yum install -y \
5681
ffmpeg-devel libjpeg-turbo-devel libpng-devel libtiff-devel atlas-devel
5782
```
5883

84+
#### macOS
85+
86+
```bash
87+
# install homebrew if not already installed
88+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
89+
90+
# install dependencies (optional - wheels are self-contained)
91+
brew install cmake boost openblas
92+
```
93+
94+
**Note:** macOS wheels are self-contained with bundled dependencies, so you may not need to install additional packages.
95+
5996
### verify the install
6097

6198
```python
@@ -68,18 +105,25 @@ print("dlib installed correctly")
68105

69106
### troubleshooting
70107

71-
* **import errors**: install runtime deps, then reinstall the wheel
72-
* **arch mismatch**: wheel must match `uname -m`
108+
- **import errors**: install runtime deps, then reinstall the wheel
109+
- **arch mismatch**: wheel must match your CPU architecture
73110

74111
```bash
112+
# check your architecture
75113
uname -m
114+
# x86_64 = Intel Mac or Linux x86_64
115+
# arm64 = Apple Silicon Mac
116+
# aarch64 = Linux ARM64
76117
```
77-
* **python mismatch**: wheel must match `python --version`
118+
119+
- **python mismatch**: wheel must match `python --version`
78120

79121
```bash
80122
python --version
81123
```
82124

125+
- **macOS platform error**: make sure you download the macOS wheel (macosx*\*), not linux wheel (linux*_ or manylinux\__)
126+
83127
### build from source (optional)
84128

85129
only needed if you require a custom build:
@@ -107,6 +151,6 @@ dlib is distributed under its original license. see the license here: [https://g
107151

108152
### links
109153

110-
* dlib repo: [https://github.com/davisking/dlib](https://github.com/davisking/dlib)
111-
* docs: [http://dlib.net/](http://dlib.net/)
112-
* python examples: [https://github.com/davisking/dlib/tree/master/python_examples](https://github.com/davisking/dlib/tree/master/python_examples)
154+
- dlib repo: [https://github.com/davisking/dlib](https://github.com/davisking/dlib)
155+
- docs: [http://dlib.net/](http://dlib.net/)
156+
- python examples: [https://github.com/davisking/dlib/tree/master/python_examples](https://github.com/davisking/dlib/tree/master/python_examples)

0 commit comments

Comments
 (0)