Setup Instructions

Please make sure to follow Driver Installation to install the Gaudi driver on the system.

Follow the Docker Installation guide to setup the Habana runtime for Docker images.

Build and Run the Benchmark Docker instance

Docker Run

To run these models on your Gaudi machine:

1. First, obtain the benchmark scripts from the Optimum-Habana repository using the command below

git clone https://github.com/huggingface/optimum-habana
cd optimum-habana/examples/text-generation/docker
Use the following recipe as a reference to construct your own Dockerfile: ARG DOCKER_URL=vault.habana.ai/gaudi-docker VERSION=1.24.0 BASE_NAME=ubuntu24.04 PT_VERSION=2.10.0 REVISION=latest REPO_TYPE=habanalabs OH_FORK_COMMIT=v1.21.0 DEEPSPEED_COMMIT=1.23.0 FROM ${DOCKER_URL}/${VERSION}/${BASE_NAME}/${REPO_TYPE}/pytorch-installer-${PT_VERSION}:${REVISION} ENV OMPI_MCA_btl_vader_single_copy_mechanism=none RUN apt update && apt install -y gettext moreutils jq npm && npm install -g n && ln -sf /usr/bin/python3 /usr/bin/python && python3 -m pip install --no-cache-dir -U pip git+https://github.com/HabanaAI/DeepSpeed.git@${DEEPSPEED_COMMIT} && cd /root && git clone https://github.com/huggingface/optimum-habana && cd optimum-habana && git checkout ${OH_FORK_COMMIT} && pip install -e . && cd examples/text-generation && python3 -m pip install -r requirements.txt -r requirements_lm_eval.txt

IMPORTANT: All build and run steps listed in this document need to be executed on Gaudi Hardware

2. To build the oh-1.24.0-gaudi image from the Dockerfile, use the command below.

## Set the next line if you are using a HTTP proxy on your build machine
BUILD_ARGS="--build-arg http_proxy --build-arg https_proxy --build-arg no_proxy"
docker build -f Dockerfile $BUILD_ARGS -t oh-1.24.0-gaudi .

Single Card Models

1. Run the container and load a shell into it. For HABANA_VISIBLE_DEVICES, choose a single, available card from 0 through 7

HFCACHE="/mnt/hf_cache"
MOUNT="/mnt/data"
VOLUME_OPTS="-v ${HFCACHE}:/hf_cache -v ${MOUNT}:/data"
DOCKER_OPTS="-e OMPI_MCA_btl_vader_single_copy_mechanism=none --cap-add=sys_nice --ipc=host -d --runtime=habana --restart always"
DOCKER_OPTS="${DOCKER_OPTS} -e HF_TOKEN=$hf_token -e http_proxy=$http_proxy -e https_proxy=$https_proxy -e no_proxy=$no_proxy"
docker run --entrypoint /bin/bash ${DOCKER_OPTS} -e HABANA_VISIBLE_DEVICES=4 ${VOLUME_OPTS} --name oh-1.24.0 oh-1.24.0-gaudi -c "sleep infinity"
docker exec -it oh-1.24.0 bash

2.Build Measurement files for Single Card models - this needs to be run once per model.

• Change the value for model_name to the one you need to use
• Set world_size to the number of HPUs recommended as per the table above

export model_name=meta-llama/Llama-3.1-8B-Instruct
export world_size=1
export PT_HPU_LAZY_MODE=1
export HF_TOKEN=<YOUR_TOKEN_HERE>
export HF_DATASETS_TRUST_REMOTE_CODE=true
export TQDM_DISABLE=1
export QUANT_CONFIG=/root/optimum-habana/examples/text-generation/quantization_config/maxabs_measure.json

cd /root/optimum-habana/examples/text-generation/
python3 run_lm_eval.py \
  -o acc_llama_quant.json \
  --model_name_or_path ${model_name} \
  --warmup 0 \
  --flash_attention_causal_mask \
  --attn_softmax_bf16 \
  --use_hpu_graphs \
  --trim_logits \
  --use_kv_cache \
  --bf16 \
  --batch_size 1 \
  --bucket_size=128 \
  --bucket_internal \
  --trust_remote_code \
  --tasks hellaswag lambada_openai piqa winogrande \
  --use_flash_attention \
  --flash_attention_recompute

3. Run benchmark for Single card models (world_size=1)

export QUANT_CONFIG=/root/optimum-habana/examples/text-generation/quantization_config/maxabs_quant.json
export input_len=128
export output_len=128
export batch_size=1536
export world_size=1
cd /root/optimum-habana/examples/text-generation/

python3 run_generation.py \
  --model_name_or_path ${model_name} \
  --attn_softmax_bf16 \
  --trim_logits \
  --warmup 2 \
  --use_kv_cache \
  --use_hpu_graphs \
  --limit_hpu_graphs \
  --bucket_size=128 \
  --bucket_internal \
  --attn_batch_split 2 \
  --bf16 \
  --flash_attention_causal_mask \
  --use_flash_attention \
  --flash_attention_recompute \
  --batch_size ${batch_size} \
  --max_new_tokens ${output_len} \
  --max_input_tokens ${input_len}

Multi-card Models

1. Run the container and load a shell into it. For HABANA_VISIBLE_DEVICES, chose multiple available cards based on the recommended number of HPUs as per the table above

HFCACHE="/mnt/hf_cache"
MOUNT="/mnt/data"
VOLUME_OPTS="-v ${HFCACHE}:/hf_cache -v /mnt/data/workspace:/mnt/workspace -v ${MOUNT}:/data"
DOCKER_OPTS="-e OMPI_MCA_btl_vader_single_copy_mechanism=none --cap-add=sys_nice --ipc=host -d --runtime=habana --restart always"
DOCKER_OPTS="${DOCKER_OPTS} -e HF_TOKEN=$hf_token -e http_proxy=$http_proxy -e https_proxy=$https_proxy -e no_proxy=$no_proxy"
docker run --entrypoint /bin/bash ${DOCKER_OPTS} -e HABANA_VISIBLE_DEVICES=6,7 ${VOLUME_OPTS} --name oh-1.24.0_multi oh-1.24.0-gaudi -c "sleep infinity"
docker exec -it oh-1.24.0_multi bash

2. Build Measurement files - this needs to be run once per model.

• Change the value for model_name to the one you need to use
• Set world_size to the number of HPUs recommended as per the table above
   

export model_name=meta-llama/Llama-3.1-70B-Instruct
export world_size=2
export PT_HPU_LAZY_MODE=1
export PT_HPU_ENABLE_LAZY_COLLECTIVES=true
export HF_TOKEN=<YOUR_TOKEN_HERE>
export HF_DATASETS_TRUST_REMOTE_CODE=true
export TQDM_DISABLE=1
export QUANT_CONFIG=./quantization_config/maxabs_measure.json

cd /root/optimum-habana/examples/text-generation/
python3 ../gaudi_spawn.py \
  --use_deepspeed --world_size ${world_size}  run_lm_eval.py \
  -o acc_llama_quant.json \
  --model_name_or_path ${model_name} \
  --warmup 0 \
  --flash_attention_causal_mask \
  --attn_softmax_bf16 \
  --use_hpu_graphs \
  --trim_logits \
  --use_kv_cache \
  --bf16 \
  --batch_size 1 \
  --bucket_size=128 \
  --bucket_internal \
  --trust_remote_code \
  --tasks hellaswag lambada_openai piqa winogrande \
  --use_flash_attention \
  --flash_attention_recompute 

3. Run benchmark for Multi-card models (world_size>1)

export QUANT_CONFIG=./quantization_config/maxabs_quant.json
export input_len=128
export output_len=128
export batch_size=2048
cd /root/optimum-habana/examples/text-generation/
python3 ../gaudi_spawn.py \
  --use_deepspeed \
  --world_size ${world_size} \
  run_generation.py \
  --model_name_or_path ${model_name} \
  --attn_softmax_bf16 \
  --trim_logits \
  --warmup 2 \
  --use_kv_cache \
  --use_hpu_graphs \
  --limit_hpu_graphs \
  --bucket_size=128 \
  --bucket_internal \
  --attn_batch_split 2 \
  --bf16 \
  --flash_attention_causal_mask \
  --use_flash_attention \
  --flash_attention_recompute \
  --batch_size ${batch_size} \
  --max_new_tokens ${output_len} \
  --max_input_tokens ${input_len}