Adds Huggingface GenAI container build specs into pytorch/Dockerfile and pytorch/docker-compose.yaml (#146)

Signed-off-by: tylertitsworth <tyler.titsworth@intel.com>
Signed-off-by: Harsha Ramayanam <harsha.ramayanam@intel.com>
Co-authored-by: tylertitsworth <tyler.titsworth@intel.com>
Co-authored-by: Tyler Titsworth <titswortht@gmail.com>

Author: 3 people

pytorch/Dockerfile

@@ -135,6 +135,13 @@ RUN wget -q  --no-check-certificate https://raw.githubusercontent.com/oneapi-src
 
 ENTRYPOINT ["/usr/local/bin/dockerd-entrypoint.sh"]
 
+FROM multinode AS hf-genai
+
+COPY hf-genai-requirements.txt .
+
+RUN python -m pip install --no-cache-dir -r hf-genai-requirements.txt && \
+    rm -rf hf-genai-requirements.txt
+
 FROM ${PYTHON_BASE} AS ipex-xpu-base
 
 RUN apt-get update && \

pytorch/README.md

@@ -239,6 +239,27 @@ Additionally, if you have a [DeepSpeed* configuration](https://www.deepspeed.ai/
 
 ---
 
+#### Hugging Face Generative AI Container
+
+The image below is an extension of the IPEX Multi-Node Container designed to run Hugging Face Generative AI scripts. The container has the typical installations needed to run and fine tune PyTorch generative text models from Hugging Face. It can be used to run multinode jobs using the same instructions from the [IPEX Multi-Node container](#setup-and-run-ipex-multi-node-container).
+
+| Tag(s)                | Pytorch  | IPEX         | oneCCL               | transformers       | Dockerfile      |
+| --------------------- | -------- | ------------ | -------------------- | --------- | --------------- |
+| `2.3.0-pip-multinode-hf-4.41.2-genai` | [v2.3.1](https://github.com/pytorch/pytorch/releases/tag/v2.3.1) | [v2.3.0+cpu] | [v2.3.0][ccl-v2.3.0] | [v4.41.2]  | [v0.4.0-Beta]   |
+
+Below is an example that shows single node job with the existing [`finetune.py`](../workflows/charts/huggingface-llm/scripts/finetune.py) script.
+
+```bash
+# Change into home directory first and run the command
+docker run -it \
+    -v $PWD/workflows/charts/huggingface-llm/scripts:/workspace/scripts \
+    -w /workspace/scripts \
+    intel/intel-extension-for-pytorch:2.3.0-pip-multinode-hf-4.41.2-genai \
+    bash -c 'python finetune.py <script-args>'
+```
+
+---
+
 The images below are [TorchServe*] with CPU Optimizations:
 
 | Tag(s)              | Pytorch  | IPEX         | Dockerfile      |
@@ -373,6 +394,9 @@ It is the image user's responsibility to ensure that any use of The images below
 [ccl-v2.1.0]: https://github.com/intel/torch-ccl/releases/tag/v2.1.0%2Bcpu
 [ccl-v2.0.0]: https://github.com/intel/torch-ccl/releases/tag/v2.1.0%2Bcpu
 
+<!-- HuggingFace transformers releases -->
+[v4.41.2]: https://github.com/huggingface/transformers/releases/tag/v4.41.2
+
 [803]: https://dgpu-docs.intel.com/releases/LTS_803.29_20240131.html
 [736]: https://dgpu-docs.intel.com/releases/stable_736_25_20231031.html
 [647]: https://dgpu-docs.intel.com/releases/stable_647_21_20230714.html

pytorch/docker-compose.yaml

@@ -189,3 +189,15 @@ services:
       - 8082:8082
       - 7070:7070
       - 7071:7071
+  hf-genai:
+    build:
+      args:
+        HF_VERSION: ${HF_VERSION:-4.41.2}
+      labels:
+        dependency.python.pip: hf-genai-requirements.txt
+        org.opencontainers.base.name: "intel/intel-optimized-pytorch:${IPEX_VERSION:-2.3.0}-${PACKAGE_OPTION:-pip}-multinode"
+        org.opencontainers.image.title: "Intel® Extension for PyTorch MultiNode Huggingface Generative AI Image"
+        org.opencontainers.image.version: ${IPEX_VERSION:-2.3.0}-${PACKAGE_OPTION:-pip}-multinode-hf-${HF_VERSION:-4.41.2}-genai"
+      target: hf-genai
+    extends: multinode
+    image: ${REGISTRY}/${REPO}:b-${GITHUB_RUN_NUMBER:-0}-${BASE_IMAGE_NAME:-ubuntu}-${BASE_IMAGE_TAG:-22.04}-${PACKAGE_OPTION:-pip}-py${PYTHON_VERSION:-3.10}-ipex-${IPEX_VERSION:-2.3.0}-hf-${HF_VERSION:-4.41.2}

pytorch/hf-genai-requirements.txt

@@ -0,0 +1,15 @@
+accelerate==0.28.0
+datasets==2.19.0
+einops==0.7.0
+evaluate==0.4.1
+nltk==3.8.1
+onnxruntime-extensions==0.10.1
+onnxruntime==1.17.3
+peft==0.10.0
+protobuf==4.24.4
+py-cpuinfo==9.0.0
+rouge_score==0.1.2
+scikit-learn==1.5.0
+SentencePiece==0.2.0
+tokenizers==0.19.1
+transformers==4.41.2

pytorch/tests/tests.yaml

@@ -27,6 +27,9 @@ import-xpu-jupyter-${PACKAGE_OPTION:-pip}:
 import-cpu-oneccl-${PACKAGE_OPTION:-pip}:
   img: ${REGISTRY}/${REPO}:b-${GITHUB_RUN_NUMBER:-0}-${BASE_IMAGE_NAME:-ubuntu}-${BASE_IMAGE_TAG:-22.04}-${PACKAGE_OPTION:-pip}-py${PYTHON_VERSION:-3.10}-ipex-${IPEX_VERSION:-2.3.0}-oneccl-inc-${INC_VERSION:-2.6}
   cmd: python -c "'import oneccl_bindings_for_pytorch as oneccl;print(oneccl.__version__)'"
+import-cpu-transformers-${PACKAGE_OPTION:-pip}:
+  img: ${REGISTRY}/${REPO}:b-${GITHUB_RUN_NUMBER:-0}-${BASE_IMAGE_NAME:-ubuntu}-${BASE_IMAGE_TAG:-22.04}-${PACKAGE_OPTION:-pip}-py${PYTHON_VERSION:-3.10}-ipex-${IPEX_VERSION:-2.3.0}-hf-${HF_VERSION:-4.41.2}
+  cmd: python -c "import transformers;print(f'transformers {transformers.__version__}');assert transformers.utils.import_utils.is_ipex_available()"
 import-cpu-inc-${PACKAGE_OPTION:-pip}:
   img: ${REGISTRY}/${REPO}:b-${GITHUB_RUN_NUMBER:-0}-${BASE_IMAGE_NAME:-ubuntu}-${BASE_IMAGE_TAG:-22.04}-${PACKAGE_OPTION:-pip}-py${PYTHON_VERSION:-3.10}-ipex-${IPEX_VERSION:-2.3.0}-oneccl-inc-${INC_VERSION:-2.6}
   cmd: python -c "'import neural_compressor as inc;print(inc.__version__)'"