Update READMEs (#430)

* update readme gaudi part & add tei-gaudi params

Signed-off-by: letonghan <letong.han@intel.com>

* modify supported habana driver version

Signed-off-by: letonghan <letong.han@intel.com>

* update env set part

Signed-off-by: letonghan <letong.han@intel.com>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add example for no_proxy

Signed-off-by: letonghan <letong.han@intel.com>

* add an example of public ip

Signed-off-by: letonghan <letong.han@intel.com>

---------

Signed-off-by: letonghan <letong.han@intel.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Letong Han
2024-07-23 15:25:02 +08:00
committed by GitHub
parent 2f9397e012
commit 8ad7f36fe2
13 changed files with 129 additions and 53 deletions

View File

@@ -29,8 +29,11 @@ To set up environment variables for deploying Code Translation services, follow
1. Set the required environment variables:
```bash
# Example: host_ip="192.168.1.1"
export host_ip="External_Public_IP"
# Example: no_proxy="localhost, 127.0.0.1, 192.168.1.1"
export no_proxy="Your_No_Proxy"
export HUGGINGFACEHUB_API_TOKEN="Your_Huggingface_API_Token"
```
2. If you are in a proxy environment, also set the proxy-related environment variables:
@@ -38,27 +41,28 @@ export no_proxy="Your_No_Proxy"
```bash
export http_proxy="Your_HTTP_Proxy"
export https_proxy="Your_HTTPs_Proxy"
export HUGGINGFACEHUB_API_TOKEN="Your_Huggingface_API_Token"
```
3. Set up other environment variables:
```bash
bash ./docker/set_env.sh
source ./docker/set_env.sh
```
## Deploy with Docker
### Deploy Code Translation on Gaudi
- If your version of `Habana Driver` < 1.16.0 (check with `hl-smi`), run the following command directly to start Code Translation services. Please find corresponding [docker_compose.yaml](./docker/gaudi/docker_compose.yaml).
Please find corresponding [docker_compose.yaml](./docker/gaudi/docker_compose.yaml).
```bash
cd GenAIExamples/CodeTrans/docker/gaudi
docker compose -f docker_compose.yaml up -d
```
- If your version of `Habana Driver` >= 1.16.0, refer to the [Gaudi Guide](./docker/gaudi/README.md) to build docker images from source.
> Notice: Currently only the <b>Habana Driver 1.16.x</b> is supported for Gaudi.
Please refer to the [Gaudi Guide](./docker/gaudi/README.md) to build docker images from source.
### Deploy Code Translation on Xeon