Skip to content

Add docker to readme #695

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

Merged
merged 10 commits into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
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
64 changes: 64 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,70 @@ pip install -e .
```
> Using `-e` for "editable" mode can help resolve potential module import issues.

#### Install from docker
The environment information of dockers provided is as following:
- OS:Euler2.8
- CANN:7.0
- Python:3.9
- MindSpore:2.2.10
- MindSpore Lite:2.2.10

Please follow the steps to install docker:

1. Download docker
- 910:
```bash
docker pull swr.cn-central-221.ovaijisuan.com/mindocr/mindocr_dev_910_ms_2_2_10_cann7_0_py39:v1
```
- 910*:
```bash
docker pull swr.cn-central-221.ovaijisuan.com/mindocr/mindocr_dev_ms_2_2_10_cann7_0_py39:v1
```
2. Create container
```bash
docker_name="temp_mindocr"
# 910
image_name="swr.cn-central-221.ovaijisuan.com/mindocr/mindocr_dev_910_ms_2_2_10_cann7_0_py39:v1"
# 910*
image_name="swr.cn-central-221.ovaijisuan.com/mindocr/mindocr_dev_ms_2_2_10_cann7_0_py39:v1"

docker run --privileged --name ${docker_name} \
--tmpfs /tmp \
--tmpfs /run \
-v /sys/fs/cgroup:/sys/fs/cgroup:ro \
--device=/dev/davinci1 \
--device=/dev/davinci2 \
--device=/dev/davinci3 \
--device=/dev/davinci4 \
--device=/dev/davinci5 \
--device=/dev/davinci6 \
--device=/dev/davinci7 \
--device=/dev/davinci_manager \
--device=/dev/hisi_hdc \
--device=/dev/devmm_svm \
-v /etc/localtime:/etc/localtime \
-v /usr/local/Ascend/driver:/usr/local/Ascend/driver \
-v /usr/local/bin/npu-smi:/usr/local/bin/npu-smi \
--shm-size 800g \
--cpus 96 \
--security-opt seccomp=unconfined \
--network=bridge -itd ${image_name} bash
```

3. Enter container
```bash
# set docker id
container_id="your docker id"
docker exec -it --user root $container_id bash
```

4. Set environment variables
After entering container, set environment variables by the following command:
```bash
source env_setup.sh
```


#### Install from PyPI
```shell
pip install mindocr
Expand Down
63 changes: 63 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,69 @@ pip install -e .
```
> 使用 `-e` 代表可编辑模式,可以帮助解决潜在的模块导入问题。

#### 通过docker安装
目前提供的docker,环境信息如下
- 操作系统版本:Euler2.8
- CANN版本:7.0
- Python版本:3.9
- MindSpore 版本:2.2.10
- MindSpore Lite 版本:2.2.10

使用docker安装,根据以下步骤:

1. 下载docker
- 910:
```bash
docker pull swr.cn-central-221.ovaijisuan.com/mindocr/mindocr_dev_910_ms_2_2_10_cann7_0_py39:v1
```
- 910*:
```bash
docker pull swr.cn-central-221.ovaijisuan.com/mindocr/mindocr_dev_ms_2_2_10_cann7_0_py39:v1
```
2. 新建容器
```bash
docker_name="temp_mindocr"
# 910
image_name="swr.cn-central-221.ovaijisuan.com/mindocr/mindocr_dev_910_ms_2_2_10_cann7_0_py39:v1"
# 910*
image_name="swr.cn-central-221.ovaijisuan.com/mindocr/mindocr_dev_ms_2_2_10_cann7_0_py39:v1"

docker run --privileged --name ${docker_name} \
--tmpfs /tmp \
--tmpfs /run \
-v /sys/fs/cgroup:/sys/fs/cgroup:ro \
--device=/dev/davinci1 \
--device=/dev/davinci2 \
--device=/dev/davinci3 \
--device=/dev/davinci4 \
--device=/dev/davinci5 \
--device=/dev/davinci6 \
--device=/dev/davinci7 \
--device=/dev/davinci_manager \
--device=/dev/hisi_hdc \
--device=/dev/devmm_svm \
-v /etc/localtime:/etc/localtime \
-v /usr/local/Ascend/driver:/usr/local/Ascend/driver \
-v /usr/local/bin/npu-smi:/usr/local/bin/npu-smi \
--shm-size 800g \
--cpus 96 \
--security-opt seccomp=unconfined \
--network=bridge -itd ${image_name} bash
```

3. 进入容器
```bash
# 设置docker id
container_id="your docker id"
docker exec -it --user root $container_id bash
```

4. 设置环境变量
进入容器后,设置环境变量:
```bash
source env_setup.sh
```

#### 通过PyPI安装
```shell
pip install mindocr
Expand Down