ermiaazarkhalili
/

Llama-3.1-8B-Instruct_Function_Calling_xLAM

@@ -1,199 +1,147 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
 ## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
+license: cc-by-nc-4.0
+tags:
+- text-generation
+- llama-3.1-8b-instruct
+- function-calling
+- finetuned-model
+- trl
+- lora
+- Salesforce/xlam-function-calling-60k
+datasets:
+- Salesforce/xlam-function-calling-60k
+base_model: meta-llama/Llama-3.1-8B-Instruct
 library_name: transformers
+languages:
+- en
+pipeline_tag: text-generation
 ---
+# Llama-3.1-8B-Instruct Fine-tuned on xLAM
+## Overview
+This is a fine-tuned version of the Llama-3.1-8B-Instruct model. The model was trained using Hugging Face's TRL library on the xLAM dataset for function calling capabilities.
 ## Model Details
+- **Developed by:** ermiaazarkhalili
+- **License:** cc-by-nc-4.0
+- **languages:** en
+- **Finetuned from model:** meta-llama/Llama-3.1-8B-Instruct
+- **Model size:** Llama-3.1-8B-Instruct parameters
+- **Vocab size:** 128,256 tokens
+- **Max sequence length:** 2,048 tokens
+- **Tensor type:** BF16
+- **Pad token:** `<|eot_id|>` (ID: 128009)
+## Training Information
+The model was fine-tuned using the following configuration:
+### Training Libraries
+- **Hugging Face TRL Library** for advanced training techniques
+- **LoRA (Low-Rank Adaptation)** for parameter-efficient training
+- **4-bit quantization** for memory efficiency
+### Training Parameters
+- **Learning Rate:** 0.0001
+- **Batch Size:** 16
+- **Gradient Accumulation Steps:** 8
+- **Max Training Steps:** 1,000
+- **Warmup Ratio:** 0.1
+- **Max Sequence Length:** 2,048
+- **Output Directory:** ./Llama_3_1_8B_Instruct_xLAM
+### LoRA Configuration
+- **LoRA Rank (r):** 16
+- **LoRA Alpha:** 32
+- **Target Modules:** Query and Value projections
+- **LoRA Dropout:** 0.1
+## Usage
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+import torch
+# Load model and tokenizer
+model = AutoModelForCausalLM.from_pretrained(
+    "ermiaazarkhalili/Llama-3.1-8B-Instruct_Function_Calling_xLAM",
+    torch_dtype=torch.bfloat16,
+    device_map="auto",
+    trust_remote_code=True
+)
+tokenizer = AutoTokenizer.from_pretrained(
+    "ermiaazarkhalili/Llama-3.1-8B-Instruct_Function_Calling_xLAM",
+    trust_remote_code=True
+)
+text= "<user>Check if the numbers 8 and 1233 are powers of two.</user>\n\n<tools>"
+# Tokenize and generate
+inputs = tokenizer(text, return_tensors="pt").to(model.device)
+outputs = model.generate(
+    **inputs,
+    max_new_tokens=512,
+    temperature=0.7,
+    do_sample=True,
+    pad_token_id=tokenizer.pad_token_id,
+    eos_token_id=tokenizer.eos_token_id
+)
+# Decode response
+response = tokenizer.decode(outputs[0], skip_special_tokens=True)
+generated_text = response[len(text):].strip()
+print(generated_text)
+```
+## Dataset
+The model was trained on the **xLAM** dataset.
+## Model Performance
+This fine-tuned model demonstrates improved capabilities in:
+- **Function Detection:** Identifying when to call functions
+- **Parameter Extraction:** Extracting correct parameters from user queries
+- **Output Formatting:** Generating properly structured function calls
+- **Tool Integration:** Working with external APIs and tools
+## Credits
+This model was developed by [ermiaazarkhalili](https://huggingface.co/ermiaazarkhalili) and leverages the capabilities of:
+- **Llama-3.1-8B-Instruct** base model
+- **Hugging Face TRL** for advanced fine-tuning techniques
+- **LoRA** for parameter-efficient adaptation
+## Contact
+For any inquiries or support, please reach out to the developer at [ermiaazarkhalili](https://huggingface.co/ermiaazarkhalili).
+## Acknowledgments
+We would like to thank the creators of:
+- **Llama-3.1-8B-Instruct** for the excellent base model
+- **Hugging Face** for the TRL library and infrastructure
+- **xLAM** dataset contributors
+- **LoRA** researchers for parameter-efficient fine-tuning methods
+## Citation
+If you use this model, please cite:
+```bibtex
+@misc{ermiaazarkhalili_Llama-3.1-8B-Instruct_Function_Calling_xLAM,
+author = {ermiaazarkhalili},
+title = { Fine-tuning  Llama-3.1-8B-Instruct on xLAM for Function Calling},
+year = {2025},
+publisher = {Hugging Face},
+howpublished = {\url{https://huggingface.co/ermiaazarkhalili/Llama-3.1-8B-Instruct_Function_Calling_xLAM}}
+}
+```