Skip to content

Commit d68922a

Browse files
feat: add llama-3.1-8b-instruct model card and deployment guide for Dell EI
Signed-off-by: arpannookala-12 <ganesh.arpan.nookala@cloud2labs.com>
1 parent 4df0676 commit d68922a

3 files changed

Lines changed: 208 additions & 0 deletions

File tree

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Deployed with EI Version-1.2
2+
3+
## Step 1: Set Environment Variables
4+
5+
```bash
6+
# Export Hugging Face token
7+
export HUGGING_FACE_HUB_TOKEN="your_token_here"
8+
9+
# Set your base URL and API token
10+
export BASE_HOST="your-cluster-url"
11+
12+
#generate keyclock token
13+
export BASE_URL="https://your-cluster-url"
14+
export KEYCLOAK_CLIENT_ID=api
15+
export KEYCLOAK_CLIENT_SECRET="your keyclock client secret"
16+
export TOKEN=$(curl -k -X POST $BASE_URL/token -H 'Content-Type: application/x-www-form-urlencoded' -d "grant_type=client_credentials&client_id=${KEYCLOAK_CLIENT_ID}&client_secret=${KEYCLOAK_CLIENT_SECRET}" | jq -r .access_token)
17+
```
18+
19+
## Step 2: Deploy Llama-3.1-8B-Instruct Model
20+
21+
```bash
22+
helm install vllm-llama-8b ./core/helm-charts/vllm \
23+
--values ./core/helm-charts/vllm/gaudi3-values.yaml \
24+
--set LLM_MODEL_ID="meta-llama/Llama-3.1-8B-Instruct" \
25+
--set global.HUGGINGFACEHUB_API_TOKEN="$HUGGING_FACE_HUB_TOKEN" \
26+
--set ingress.enabled=true \
27+
--set ingress.host="$BASE_HOST" \
28+
--set ingress.secretname="$BASE_HOST" \
29+
--force
30+
```
31+
32+
## Step 3: Test the Deployed Model
33+
34+
```bash
35+
curl -k ${BASE_URL}/Llama-3.1-8B-Instruct/v1/completions \
36+
-X POST \
37+
-H "Content-Type: application/json" \
38+
-H "Authorization: Bearer $TOKEN" \
39+
-d '{
40+
"model": "meta-llama/Llama-3.1-8B-Instruct",
41+
"prompt": "What is Deep Learning?",
42+
"max_tokens": 25,
43+
"temperature": 0
44+
}'
45+
```
46+
## To undeploy the model
47+
48+
```bash
49+
helm uninstall vllm-llama-8b
50+
```
51+
## Parameters
52+
53+
| Parameter | Description |
54+
| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
55+
| `--set LLM_MODEL_ID="meta-llama/Llama-3.1-8B-Instruct"` | Defines the target model from **Hugging Face** to deploy. |
56+
| `--set global.HUGGINGFACEHUB_API_TOKEN="..."` | Authenticates access to gated or private Hugging Face models. Replace with your own secure token. |
57+
| `--set ingress.enabled=true` | Enables Kubernetes **Ingress** to expose the model service externally. |
58+
| `--set ingress.host="replace-ingress"` | Public hostname or FQDN for the inference endpoint (maps to your Ingress controller IP). |
59+
| `--set ingress.secretname="replace-secret"` | Kubernetes **TLS Secret** used for HTTPS termination at the ingress layer. |
60+
61+
62+
63+
64+
65+
66+
67+
68+
69+
70+
71+
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Llama-3.1-8B-Instruct
2+
3+
This model uses Llama-3.1-8B-Instruct, a 8 billion-parameter instruction-tuned model from Meta Platforms, Inc. (Meta AI). It belongs to the Llama 3.1 model family and is optimized for multilingual dialogue, code tasks, and general instruction-following across a large context window.
4+
5+
For full details including model specifications, licensing, intended use, safety guidance, and example prompts, please visit the official Hugging Face page: **Official Hugging Face Page**
6+
7+
https://huggingface.co/meta-llama/Llama-3.1-8B-Instruct
8+
9+
This model provides inference services only; weights are hosted by Hugging Face under Meta’s license.
10+
11+
Ensure compliance with the Llama 2 Community License Agreement before using this model.
12+
13+
### Model Attribution
14+
15+
**Developer:** Meta Platforms, Inc. (Meta AI)
16+
17+
**purpose:** Instruction-following model for dialogue, code generation/completion, multilingual tasks
18+
19+
**Sizes/Variants:** 8 B parameters (instruction tuned); the Llama 3.1 family also includes 70 B and 405 B parameter variants
20+
21+
**Modalities:** Text input → Text (including code) output
22+
23+
**Parameter Size:** ~8 billion
24+
25+
**Max Context:** Up to ~128 k tokens (for the 3.1 family)
26+
27+
**License:** Llama 3.1 Community License (custom commercial license)
28+
29+
**Minimum required CPU Cores:** 157
30+
31+
**Minimum required PCIe Cards:** 1
32+
33+
### Usage Notice
34+
35+
**By using this model, you agree that:**
36+
37+
- Inputs and outputs are processed through Llama-3.1-8B-Instruct under Meta’s Community License.
38+
- You will comply with Meta’s licensing terms, including restrictions on redistribution, commercial scale-use thresholds, attribution (“Built with Llama”), and acceptable use policy.
39+
- All generated content (text or code) must be reviewed for accuracy, compliance, and safety before deployment.
40+
- The model should not be used for generating malicious content, disallowed content, or automating decisions in high-risk or regulated systems without appropriate safeguards.
41+
42+
### Intended Applications
43+
44+
- Instruction-following chatbots and assistants (multilingual)
45+
- Code generation, completion, refactoring tasks (Python, Java, JavaScript, etc.)
46+
- Multilingual support (English, German, French, Italian, Portuguese, Hindi, Spanish, Thai) and potentially others with fine-tuning.
47+
- Large-context tasks: summarization of long documents, dialog over long history, RAG (retrieve-and-generate) over extended context.
48+
- Research, prototyping, and commercial workflows (subject to license terms).
49+
50+
### Limitations
51+
52+
- Although capable, the 8 B size still has trade-offs: accuracy and depth of reasoning may lag behind much larger models.
53+
- As with all large language models, risk of hallucinations (incorrect statements), biases, or unsafe outputs remains.
54+
- The custom license restricts certain uses (e.g., if your product has > 700 million monthly active users you may require a special license) as described in Meta’s license terms.
55+
- The model does not guarantee tool-use, vision/multimodal input (unless you fine-tune or wrap appropriately) – it is primarily text → text.
56+
- Running it efficiently still requires significant hardware/resources for full context and best performance
57+
58+
### References
59+
60+
“Introducing Llama 3.1: Our most capable models to date”. https://ai.meta.com/blog/meta-llama-3-1
61+
62+
Hugging Face Model Card: https://huggingface.co/meta-llama/Llama-3.1-8B-Instruct
63+
64+
Meta Llama GitHub Repository & License Details. https://github.com/meta-llama/llama3
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
2+
# Deployed with EI Version-1.3.1
3+
4+
## Step 1: Set Environment Variables
5+
6+
```bash
7+
# Export Hugging Face token
8+
export HUGGING_FACE_HUB_TOKEN="your_token_here"
9+
10+
# Set your base URL and API token
11+
export BASE_HOST="your-cluster-url"
12+
13+
#generate keyclock token
14+
export BASE_URL="https://your-cluster-url"
15+
export KEYCLOAK_CLIENT_ID=api
16+
export KEYCLOAK_CLIENT_SECRET="your keyclock client secret"
17+
export TOKEN=$(curl -k -X POST $BASE_URL/token -H 'Content-Type: application/x-www-form-urlencoded' -d "grant_type=client_credentials&client_id=${KEYCLOAK_CLIENT_ID}&client_secret=${KEYCLOAK_CLIENT_SECRET}" | jq -r .access_token)
18+
```
19+
20+
## Step 2: Deploy Llama-3.1-8B-Instruct Model
21+
22+
```bash
23+
helm install vllm-llama-8b-cpu ./core/helm-charts/vllm \
24+
--values ./core/helm-charts/vllm/xeon-values.yaml \
25+
--set LLM_MODEL_ID="meta-llama/Llama-3.1-8B-Instruct" \
26+
--set global.HUGGINGFACEHUB_API_TOKEN="$HUGGING_FACE_HUB_TOKEN" \
27+
--set ingress.enabled=false \
28+
--set ingress.host="${BASE_HOST}" \
29+
--set oidc.client_id="$KEYCLOAK_CLIENT_ID" \
30+
--set oidc.client_secret="$KEYCLOAK_CLIENT_SECRET" \
31+
--set apisix.enabled=true \
32+
--set tensor_parallel_size="1" \
33+
--set pipeline_parallel_size="1"
34+
```
35+
36+
## Step 3: Test the Deployed Model
37+
38+
```bash
39+
curl -k ${BASE_URL}/Llama-3.1-8B-Instruct-vllmcpu/v1/completions \
40+
-X POST \
41+
-H "Content-Type: application/json" \
42+
-H "Authorization: Bearer $TOKEN" \
43+
-d '{
44+
"model": "meta-llama/Llama-3.1-8B-Instruct",
45+
"prompt": "What is Deep Learning?",
46+
"max_tokens": 25,
47+
"temperature": 0
48+
}'
49+
```
50+
51+
## To undeploy the model
52+
53+
```bash
54+
helm uninstall vllm-llama-8b-cpu
55+
```
56+
## Parameters
57+
58+
| Parameter | Description |
59+
| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
60+
| `--set LLM_MODEL_ID="meta-llama/Llama-3.1-8B-Instruct"` | Defines the target model from **Hugging Face** to deploy. |
61+
| `--set global.HUGGINGFACEHUB_API_TOKEN="..."` | Authenticates access to gated or private Hugging Face models. Replace with your own secure token. |
62+
| `--set ingress.enabled=true` | Enables Kubernetes **Ingress** to expose the model service externally. |
63+
| `--set ingress.host="replace-ingress"` | Public hostname or FQDN for the inference endpoint (maps to your Ingress controller IP). |
64+
| `--set ingress.secretname="replace-secret"` | Kubernetes **TLS Secret** used for HTTPS termination at the ingress layer. |
65+
66+
67+
68+
69+
70+
71+
72+
73+

0 commit comments

Comments
 (0)