Update README.md

README.md

@@ -1,21 +1,52 @@
 ---
-license: cc-by-4.0
+license: cc-by-nc-4.0
 ---
+
 <p align="center">
 <img width="300px" alt="xLAM" src="https://huggingface.co/Salesforce/xLAM-v0.1-r/resolve/main/xlam-no-background.png">
 </p>
-<p align="center"><a href="https://apigen-pipeline.github.io/">[🏠Homepage]</a>  |  <a href="https://coder.deepseek.com/">[📄 Paper]</a> | <a href="https://coder.deepseek.com/">[📚 Dataset]</a></p>
+<p align="center">
+  <a href="https://apigen-pipeline.github.io/">[Homepage]</a>  |  
+  <a href="https://arxiv.org/abs/2406.18518">[Paper]</a> | 
+  <a href="https://huggingface.co/datasets/Salesforce/xlam-function-calling-60k">[Dataset]</a> | 
+  <a href="https://github.com/SalesforceAIResearch/xLAM">[Github]</a>
+</p>
 <hr>
 
+Welcome to the xLAM model family! [Large Action Models (LAMs)](https://blog.salesforceairesearch.com/large-action-models/) are advanced large language models designed to enhance decision-making and translate user intentions into executable actions that interact with the world. LAMs autonomously plan and execute tasks to achieve specific goals, serving as the brains of AI agents. They have the potential to automate workflow processes across various domains, making them invaluable for a wide range of applications.
+
 ## Model Summary
 
-This repo provides the GGUF format for the xLAM-1B-FC-r model. Here's a link to original model [xLAM-1B-FC-r](https://huggingface.co/agentstudio-family/xLAM-1B-FC-r)
+This repo provides the GGUF format for the xLAM-1b-fc-r model. Here's a link to original model [xLAM-1b-fc-r](https://huggingface.co/salesforce/xLAM-1b-fc-r)
 This model is designed for function composition and tool utilization tasks, providing fast, accurate, and structured responses based on the input queries and available tools. 
 We use [llama.cpp](https://github.com/ggerganov/llama.cpp) framework to convert models to GGUF. GGUF model files offer significant advantages in terms of interoperability, efficiency, scalability, flexibility, and ease of use. They are particularly valuable in applications requiring efficient model deployment, sharing, and optimization across diverse platforms and hardware environments.
 
-## Model Overview
+## Model Series
+
+We provide a series of xLAMs in different sizes to cater to various applications, including those optimized for function-calling and general agent applications:
+
+| Model                  | # Total Params | Context Length | Download Model  | Download GGUF files |
+|------------------------|----------------|----------------|----------------|----------|
+| xLAM-1b-fc-r           | 1.35B          | 16k            | [🤗 Link](https://huggingface.co/Salesforce/xLAM-1b-fc-r) | [🤗 Link](https://huggingface.co/Salesforce/xLAM-1b-fc-r-gguf) |
+| xLAM-7b-fc-r           | 6.91B          | 4k             | [🤗 Link](https://huggingface.co/Salesforce/xLAM-7b-fc-r) | [🤗 Link](https://huggingface.co/Salesforce/xLAM-7b-fc-r-gguf) |
+
+The `fc` series of models are optimized for function-calling capability, providing fast, accurate, and structured responses based on input queries and available APIs. These models are fine-tuned based on the [deepseek-coder](https://huggingface.co/collections/deepseek-ai/deepseek-coder-65f295d7d8a0a29fe39b4ec4) models and are designed to be small enough for deployment on personal devices like phones or computers.
+
+For more details, check our [paper](https://arxiv.org/abs/2406.18518).
+
+## Repository Overview
+
+This repository is focused on our tiny `xLAM-1b-fc-r` model, which is optimized for function-calling and can be easily deployed on personal devices.
+
+<div align="center">
+<img src="https://github.com/apigen-pipeline/apigen-pipeline.github.io/blob/main/img/function-call-overview.png?raw=true"
+alt="drawing" width="620"/>
+</div>
+
+Function-calling, or tool use, is one of the key capabilities for AI agents. It requires the model not only understand and generate human-like text but also to execute functional API calls based on natural language instructions. This extends the utility of LLMs beyond simple conversation tasks to dynamic interactions with a variety of digital services and applications, such as retrieving weather information, managing social media platforms, and handling financial services.
+
+The instructions will guide you through the setup, usage, and integration of `xLAM-1b-fc-r-gguf` with HuggingFace and llama-cpp.
 
-The `xLAM-1B-FC-r` model is a fine-tuned version of [deepseek-ai/deepseek-coder-1.3b-instruct](https://huggingface.co/deepseek-ai/deepseek-coder-1.3b-instruct), optimized for tasks that require composing functions and utilizing tools to answer queries. For more details, check our [paper](https://arxiv.org/abs/2406.18518).
 
 ## How to download GGUF files
 
@@ -32,7 +63,7 @@ huggingface-cli login
 
 3. **Download the GGUF model:**
 ```
-huggingface-cli download agentstudio-family/xLAM-1b-fc-gguf-r xLAM-1B-FC-r.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
+huggingface-cli download https://huggingface.co/Salesforce/xLAM-1b-fc-r-gguf xLAM-1B-FC-r.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
 ```
 
 ## Prompt template
@@ -58,7 +89,9 @@ You are an AI assistant for function calling.For politically sensitive questions
 ### Response:
 
 ```
-For more information, refer to [prompt-documentation](https://huggingface.co/agentstudio-family/xLAM-1B-FC-r#basic-usage-with-huggingface)
+We highly recommend using our provided `task_instruction`, `format_instruction`, and `tools` format to achieve the best performance.
+For more information, refer to [prompt-documentation](https://huggingface.co/Salesforce/xLAM-1b-fc-r#basic-usage-with-huggingface).
+
 ## Usage
 
 ### Command Line
@@ -92,4 +125,35 @@ output = llm(
       echo=True # Echo the prompt back in the output
 ) # Generate a completion, can also call create_completion
 print(output)
-```
+```
+
+## Benchmark Results
+
+We mainly test our function-calling models on the [Berkeley Function-Calling Leaderboard (BFCL)](https://gorilla.cs.berkeley.edu/leaderboard.html), which offers a comprehensive evaluation framework for assessing LLMs' function-calling capabilities across various programming languages and application domains like Java, JavaScript, and Python. 
+
+
+<div align="center">
+<img src="https://github.com/apigen-pipeline/apigen-pipeline.github.io/blob/main/img/table-result-0718.png?raw=true" width="620" alt="Performance comparison on Berkeley Function-Calling Leaderboard">
+<p>Performance comparison on the BFCL benchmark as of date 07/18/2024. Evaluated with <code>temperature=0.001</code> and <code>top_p=1</code></p> 
+</div>
+
+<p>Our <code>xLAM-7b-fc-r</code> secures the 3rd place with an overall accuracy of 88.24% on the leaderboard, outperforming many strong models. Notably, our <code>xLAM-1b-fc-r</code> model is the only tiny model with less than 2B parameters on the leaderboard, but still achieves a competitive overall accuracy of 78.94% and outperforming GPT3-Turbo and many larger models.
+Both models exhibit balanced performance across various categories, showing their strong function-calling capabilities despite their small sizes.</p>
+
+See our [paper](https://arxiv.org/abs/2406.18518) for more detailed analysis.
+
+## License
+
+`xLAM-1b-fc-r-gguf` is distributed under the CC-BY-NC-4.0 license, with additional terms specified in the [Deepseek license](https://github.com/deepseek-ai/DeepSeek-LLM/blob/main/LICENSE-MODEL).
+
+## Citation
+
+If you find this repo helpful, please cite our paper:
+```bibtex
+@article{liu2024apigen,
+  title={APIGen: Automated Pipeline for Generating Verifiable and Diverse Function-Calling Datasets},
+  author={Liu, Zuxin and Hoang, Thai and Zhang, Jianguo and Zhu, Ming and Lan, Tian and Kokane, Shirley and Tan, Juntao and Yao, Weiran and Liu, Zhiwei and Feng, Yihao and others},
+  journal={arXiv preprint arXiv:2406.18518},
+  year={2024}
+}
+```