Skip to content

Commit 3075a42

Browse files
committed
fix: docker image name from sdk package
- none Change-Id: If3e3a06b96edac864fb94a9829e621e0998d54db
1 parent f0378aa commit 3075a42

6 files changed

Lines changed: 16 additions & 15 deletions

File tree

docs/developer_manual/source_en/02_environment.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ If you are using docker for the first time, you can execute the following comman
4141
Make sure the installation package is in the current directory, and then create a container in the current directory as follows:
4242

4343
.. code-block:: shell
44-
45-
$ docker run --privileged --name myname -v $PWD:/workspace -it sophgo/tpuc_dev:v3.4
44+
$ docker run --privileged --name myname -v $PWD:/workspace -it sophgo/tpuc_dev:v3.4 # without 'sophgo' if you use image from SDK package
4645
# "myname" is just an example, you can use any name you want
4746
# use --privileged to get root permission, if you don't need root permission, please remove this parameter
4847

docs/developer_manual/source_zh/02_environment.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ TPU-MLIR在Docker环境开发, 配置好Docker就可以编译和运行了。
4646

4747
.. code-block:: shell
4848
49-
$ docker run --privileged --name myname -v $PWD:/workspace -it sophgo/tpuc_dev:v3.4
49+
$ docker run --privileged --name myname -v $PWD:/workspace -it sophgo/tpuc_dev:v3.4 # 如果是SDK包中获取的镜像则没有sophgo前缀
5050
# myname只是举个名字的例子, 请指定成自己想要的容器的名字
5151
# 使用 --privileged 参数以获取root权限,如果不需要root权限,请删除该参数
5252

docs/quick_start/source_en/02_env.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,14 @@ If you are using docker for the first time, you can execute the following comman
3232
3333
.. _docker container_setup:
3434

35-
If you download the image file, make sure the image file is in the current directory, and then create a container in the current directory as follows:
35+
You can get the docker image file from the SDK package. If you download the image file, make sure the image file is in the current directory, and then create a container in the current directory as follows:
3636

3737

3838
.. code-block:: shell
3939
4040
# use --privileged to get root permission, if you don't need root permission, please remove this parameter
41-
$ docker run --privileged --name myname -v $PWD:/workspace -it sophgo/tpuc_dev:v3.4
41+
$ docker load -i tpuc_dev_v3.4.tar.gz
42+
$ docker run --privileged --name myname -v $PWD:/workspace -it tpuc_dev:v3.4
4243
4344
where ``myname`` is the name of the container, which can be customized; ``$PWD`` is the current directory, synchronized with the container's ``/workspace`` directory.
4445

docs/quick_start/source_en/Appx.04_modelzoo_test.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,18 +171,18 @@ If you need precision test on BasicVSR, please download and unzip the Vid4 datas
171171
Prepare the toolchain compilation environment
172172
~~~~~~~~~~~~~~~~~~
173173

174-
It is recommended to use the toolchain software in a docker environment, see :ref:`Base environment configuration <docker configuration>` to install Docker. and execute the following commands in your working directory (the directory which ``model-zoo`` is located) to create a Docker container:
174+
It is recommended to use the toolchain software in a docker environment, see :ref:`Base environment configuration <docker configuration>` to install Docker. The docker image file can be obtained from the SDK package.Execute the following commands in your working directory (the directory which ``model-zoo`` is located) to create a Docker container:
175175

176176
.. code-block:: shell
177177
178-
$ docker pull sophgo/tpuc_dev:v3.4
179-
$ docker run --name myname -v $PWD:/workspace -it sophgo/tpuc_dev:v3.4
178+
$ docker load -i tpuc_dev_v3.4.tar.gz
179+
$ docker run --name myname -v $PWD:/workspace -it tpuc_dev:v3.4
180180
181181
If you want to keep the container after it exits, simply remove the ``--rm`` parameter:
182182

183183
.. code-block:: shell
184184
185-
$ docker run --name myname -v $PWD:/workspace -it sophgo/tpuc_dev:v3.4 --rm
185+
$ docker run --name myname -v $PWD:/workspace -it tpuc_dev:v3.4 --rm
186186
187187
After running the command, it will be in a Docker container. You can the latest ``tpu-mlir`` wheel installation package from the SDK package, such as ``tpu_mlir-*-py3-none-any.whl``. Install tpu_mlir in the Docker container:
188188

docs/quick_start/source_zh/02_env.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,13 @@
3232
3333
.. _docker container_setup:
3434

35-
若下载镜像文件,则需要确保镜像文件在当前目录,并在当前目录创建容器如下:
35+
镜像文件可从SDK包中获取。若下载镜像文件,则需要确保镜像文件在当前目录,并在当前目录创建容器如下:
3636

3737
.. code-block:: shell
3838
3939
# 使用 --privileged 参数以获取root权限,如果不需要root权限,请删除该参数
40-
$ docker run --privileged --name myname -v $PWD:/workspace -it sophgo/tpuc_dev:v3.4
40+
$ docker load -i tpuc_dev_v3.4.tar.gz
41+
$ docker run --privileged --name myname -v $PWD:/workspace -it tpuc_dev:v3.4
4142
4243
其中, ``myname`` 为容器名称,可以自定义; ``$PWD`` 为当前目录,与容器的 ``/workspace`` 目录同步。
4344

docs/quick_start/source_zh/Appx.04_modelzoo_test.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,18 +173,18 @@ Vid4 (可选)
173173
准备工具链编译环境
174174
~~~~~~~~~~~~~~~~~~
175175

176-
建议在 docker 环境使用工具链软件,可以参考 :ref:`基础环境配置 <docker configuration>` 安装Docker。并在工作目录(即 ``model-zoo`` 所在目录)下执行以下命令创建Docker容器
176+
建议在 docker 环境使用工具链软件,可以参考 :ref:`基础环境配置 <docker configuration>` 安装Docker。并在工作目录(即 ``model-zoo`` 所在目录)。docker镜像文件可从SDK包中获取,执行以下命令创建Docker容器
177177

178178
.. code-block:: shell
179179
180-
$ docker pull sophgo/tpuc_dev:v3.4
181-
$ docker run --name myname -v $PWD:/workspace -it sophgo/tpuc_dev:v3.4
180+
$ docker load -i tpuc_dev_v3.4.tar.gz
181+
$ docker run --name myname -v $PWD:/workspace -it tpuc_dev:v3.4
182182
183183
如果要让容器在退出后删除,可以添加 ``--rm`` 参数:
184184

185185
.. code-block:: shell
186186
187-
$ docker run --name myname -v $PWD:/workspace -it sophgo/tpuc_dev:v3.4 --r
187+
$ docker run --name myname -v $PWD:/workspace -it tpuc_dev:v3.4 --r
188188
189189
190190
运行命令后会处于Docker的容器中,从提供的SDK包中获取最新的 ``tpu-mlir`` wheel安装包,例如 ``tpu_mlir-*-py3-none-any.whl``。在Docker容器中安装TPU-MLIR:

0 commit comments

Comments
 (0)