ayo/ipex-llm
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Chronos: update how to download from dockerhub in guide (#7637)

Browse source
This commit is contained in:
binbin Deng 2023-02-22 16:51:34 +08:00 committed by GitHub
parent e5fb0a3315
commit 33306da4d4
1 changed files with 20 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/readthedocs/source/doc/Chronos/Howto/docker_guide_single_node.md
View file

@ -1,7 +1,15 @@
# Use Chronos in Container (docker) # Use Chronos in Container (docker)
This dockerfile helps user to build a docker image where Chronos-nightly build version is deployed. This page helps user to build and use a docker image where Chronos-nightly build version is deployed.
## Download image from Docker Hub
We provide docker image with Chronos-nightly build version deployed in [Docker Hub](https://hub.docker.com/r/intelanalytics/bigdl-chronos/tags). You can directly download it by running command:
```bash
docker pull intelanalytics/bigdl-chronos:latest
```
## Build an image (Optional)
**If you have downloaded docker image, you can just skip this part and go on [Use Chronos](#use-chronos).**
## Build an image
First clone the repo `BigDL` to the local. First clone the repo `BigDL` to the local.
```bash ```bash
git clone https://github.com/intel-analytics/BigDL.git git clone https://github.com/intel-analytics/BigDL.git
@ -43,7 +51,7 @@ extra_dep: whether to install some extra dependencies.
If you want to build image with the default options, you can simply use the following command: If you want to build image with the default options, you can simply use the following command:
```bash ```bash
sudo docker build -t chronos-nightly:b1 . # You may choose any NAME:TAG you want. sudo docker build -t intelanalytics/bigdl-chronos:latest . # You may choose any NAME:TAG you want.
``` ```
You can also build with other options by specifying the build args: You can also build with other options by specifying the build args:
@ -54,7 +62,7 @@ sudo docker build \
--build-arg hardware=single \ --build-arg hardware=single \
--build-arg inference=n \ --build-arg inference=n \
--build-arg extra_dep=n \ --build-arg extra_dep=n \
-t chronos-nightly:b1 . # You may choose any NAME:TAG you want. -t intelanalytics/bigdl-chronos:latest . # You may choose any NAME:TAG you want.
``` ```
(Optional) If you need a proxy, you can add two additional build args to specify it: (Optional) If you need a proxy, you can add two additional build args to specify it:
@ -63,7 +71,7 @@ sudo docker build \
sudo docker build \ sudo docker build \
--build-arg http_proxy=http://<your_proxy_ip>:<your_proxy_port> \ #optional --build-arg http_proxy=http://<your_proxy_ip>:<your_proxy_port> \ #optional
--build-arg https_proxy=http://<your_proxy_ip>:<your_proxy_port> \ #optional --build-arg https_proxy=http://<your_proxy_ip>:<your_proxy_port> \ #optional
-t chronos-nightly:b1 . # You may choose any NAME:TAG you want. -t intelanalytics/bigdl-chronos:latest . # You may choose any NAME:TAG you want.
``` ```
According to your network status, this building will cost **15-30 mins**. According to your network status, this building will cost **15-30 mins**.
@ -71,22 +79,22 @@ According to your network status, this building will cost **15-30 mins**.
## Run the image ## Run the image
```bash ```bash
sudo docker run -it --rm --net=host chronos-nightly:b1 bash sudo docker run -it --rm --net=host intelanalytics/bigdl-chronos:latest bash
``` ```
## Use Chronos ## Use Chronos
A conda environment is created for you automatically. `bigdl-chronos` and the necessary depenencies (based on the build args) are installed inside this environment. A conda environment is created for you automatically. `bigdl-chronos` and the necessary depenencies (based on the build args when you build image) are installed inside this environment.
```bash ```bash
(chronos) root@icx-5:/opt/work# (chronos) root@icx-5:/opt/work#
``` ```
```eval_rst ```eval_rst
.. important:: .. important::
Considering the image size, we build docker image with the default args and upload it to dockerhub. If you use it directly, only ``bigdl-chronos`` is installed inside this environment. There are two methods to install other necessary dependencies according to your own needs: Considering the image size, we build docker image with the default args and upload it to Docker Hub. If you use it directly, only ``bigdl-chronos`` is installed inside this environment. There are two methods to install other necessary dependencies according to your own needs:
1. Make sure network is available and run install command following `Install using Conda <https://bigdl.readthedocs.io/en/latest/doc/Chronos/Overview/install.html#install-using-conda>`_ , such as ``pip install --pre --upgrade bigdl-chronos[pytorch]``. 1. Make sure network is available and run install command following `Install using Conda <https://bigdl.readthedocs.io/en/latest/doc/Chronos/Overview/install.html#install-using-conda>`_ , such as ``pip install --pre --upgrade bigdl-chronos[pytorch]``.
2. Make sure network is available and bash ``/opt/install-python-env.sh`` with build args. The values are introduced in `Build an image <## Build an image>`_. 2. Make sure network is available and bash ``/opt/install-python-env.sh`` with build args. The values are introduced in `Build an image <#build-an-image-optional>`_.
.. code-block:: python .. code-block:: python
@ -122,10 +130,10 @@ You should shut down the BigDL Docker container after using it.
``` ```
You will see your docker containers: You will see your docker containers:
```bash ```bash
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
d6db0ab27cac chronos-nightly:b1 "bash" 2 hours ago Up 2 hours funny_aryabhata ef133bd732d1 intelanalytics/bigdl-chronos:latest "bash" 2 hours ago Up 2 hours happy_babbage
``` ```
3. Shut down the corresponding docker container by its ID: 3. Shut down the corresponding docker container by its ID:
```bash ```bash
sudo docker rm -f d6db0ab27cac sudo docker rm -f ef133bd732d1
``` ```