Skip to content

[Docs] Add reminder in docs for macOS M1 users #2268

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.

Sign up for GitHub

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

Merged
zhouzaida merged 3 commits into from
Oct 10, 2022
Merged

[Docs] Add reminder in docs for macOS M1 users #2268

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee54b42
Adding remainder in docs for M1 MacOS users
xin-li-67 Sep 18, 2022
f283483
minor refinement
zhouzaida Oct 10, 2022
ca854cf
Update README_zh-CN.md
zhouzaida Oct 10, 2022
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ There are two versions of MMCV:

a. Install the full version.

Before installing mmcv, make sure that PyTorch has been successfully installed following the [official guide](https://pytorch.org/).
Before installing mmcv, make sure that PyTorch has been successfully installed following the [official guide](https://pytorch.org/). For M1 MacOS users, please make sure you are using `PyTorch Nightly`.

We provide pre-built mmcv packages (recommended) with different PyTorch and CUDA versions to simplify the building for **Linux and Windows systems**. In addition, you can run [check_installation.py](.dev_scripts/check_installation.py) to check the installation of mmcv after running the installation commands.

Expand Down
2 changes: 1 addition & 1 deletion README_zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ MMCV 有两个版本：

a. 安装完整版

在安装 mmcv 之前，请确保 PyTorch 已经成功安装在环境中，可以参考 PyTorch [官方文档](https://pytorch.org/)。
在安装 mmcv 之前，请确保 PyTorch 已经成功安装在环境中，可以参考 PyTorch [官方文档](https://pytorch.org/)。对于M1芯片用户，请确保当前你正在使用 `PyTorch Nightly`。

我们提供了 **Linux 和 Windows 平台** PyTorch 和 CUDA 版本组合的 mmcv 预编译包，可以大大简化用户安装编译过程。强烈推荐通过预编译包来安装。另外，安装完成后可以运行 [check_installation.py](.dev_scripts/check_installation.py) 脚本检查 mmcv 是否安装成功。

Expand Down
2 changes: 1 addition & 1 deletion docs/en/get_started/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can either
pip install -e .
```

If you are on macOS, add the following environment variables before the installing command.
If you are on macOS, add the following environment variables before the installing command. Meanwhile, please make sure you are using `PyTorch Nightly` for M1 MacOS.

```bash
CC=clang CXX=clang++ CFLAGS='-stdlib=libc++'
Expand Down
2 changes: 1 addition & 1 deletion docs/en/get_started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Do not install both versions in the same environment, otherwise you may encounte

a. Install the full version.

Before installing mmcv, make sure that PyTorch has been successfully installed following the [official guide](https://pytorch.org/).
Before installing mmcv, make sure that PyTorch has been successfully installed following the [official guide](https://pytorch.org/). For M1 MacOS users, please make sure you are using `PyTorch Nightly`.

We provide pre-built mmcv packages (recommended) with different PyTorch and CUDA versions to simplify the building for **Linux and Windows systems**. In addition, you can run [check_installation.py](https://github.com/open-mmlab/mmcv/blob/2.x/.dev_scripts/check_installation.py) to check the installation of mmcv after running the installation commands.

Expand Down
2 changes: 1 addition & 1 deletion docs/zh_cn/get_started/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ MMCV_WITH_OPS=0 pip install -e .
pip install -e .
```

如果是在 macOS 上编译，则需要在安装命令前添加一些环境变量
如果是在 macOS 上编译，则需要在安装命令前添加一些环境变量，同时对于M1芯片用户，请确保当前使用的是 `PyTorch Nightly`

```bash
CC=clang CXX=clang++ CFLAGS='-stdlib=libc++'
Expand Down
2 changes: 1 addition & 1 deletion docs/zh_cn/get_started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ MMCV 有两个版本：

a. 安装完整版

在安装 mmcv 之前，请确保 PyTorch 已经成功安装在环境中，可以参考 PyTorch 官方[文档](https://pytorch.org/)。
在安装 mmcv 之前，请确保 PyTorch 已经成功安装在环境中，可以参考 PyTorch 官方[文档](https://pytorch.org/)。对于M1芯片用户，请确保当前你正在使用 `PyTorch Nightly`。

我们提供了 **Linux 和 Windows 平台** PyTorch 和 CUDA 版本组合的 mmcv 预编译包，可以大大简化用户安装编译过程。强烈推荐通过预编译包来安装。另外，安装完成后可以运行 [check_installation.py](https://github.com/open-mmlab/mmcv/blob/2.x/.dev_scripts/check_installation.py) 脚本检查 mmcv 是否安装成功。

Expand Down