Add pipeline tag, library name, and GitHub link

README.md

@@ -1,14 +1,19 @@
 ---
-license: apache-2.0
-language:
-- en
 base_model:
 - codellama/CodeLlama-7b-hf
+language:
+- en
+license: apache-2.0
+library_name: transformers
+pipeline_tag: text-generation
 ---
+
 # **TL-CodeLLaMA-2**
 
 TL-CodeLLaMA-2 is a model designed for tool use, built upon CodeLLaMA-7b. It is trained on 1,217 data samples using the *TL-Training* framework and demonstrates effective performance across a variety of tool use tasks. More information can be found in the paper "[TL-Training: A Task-Feature-Based Framework for Training Large Language Models in Tool Use](https://www.arxiv.org/abs/2412.15495)".
 
+Code: https://github.com/Junjie-Ye/TL-Training
+
 # Model Use
 
 ## Requirements
@@ -26,7 +31,49 @@ The data needs to be organized in the following format:
 [
     {
         "role": "System",
-        "content": "Function:\ndef random_advice():\n    \"\"\"\n    Returns a random advice slip as a slip object.\n    \"\"\"\n\nFunction:\ndef advice_by_id(slip_id:str):\n    \"\"\"\n    If an advice slip is found with the corresponding {slip_id}, a slip object is returned.\n\n    Args:\n        slip_id (string): The unique ID of this advice slip.\n    \"\"\"\n\nFunction:\ndef search_advice(query:str):\n    \"\"\"\n    If an advice slip is found, containing the corresponding search term in {query}, an array of slip objects is returned inside a search object.\n\n    Args:\n        query (string): The search query provided.\n    \"\"\"\n\nFunction:\ndef ask_to_user(question:str):\n    \"\"\"\n    You can ask user for guidance when you think you need more information to handle the task, but you should use this tool as less as you can.\n\n    Args:\n        question (string): The question you want to ask to user.\n    \"\"\"\n\nFunction:\ndef finish(answer:str):\n    \"\"\"\n    Finish the task and give your answer.\n\n    Args:\n        answer (string): Your answer for the task.\n    \"\"\"\n\n"
+        "content": "Function:
+def random_advice():
+    \"\"\"
+    Returns a random advice slip as a slip object.
+    \"\"\"
+
+Function:
+def advice_by_id(slip_id:str):
+    \"\"\"
+    If an advice slip is found with the corresponding {slip_id}, a slip object is returned.
+
+    Args:
+        slip_id (string): The unique ID of this advice slip.
+    \"\"\"
+
+Function:
+def search_advice(query:str):
+    \"\"\"
+    If an advice slip is found, containing the corresponding search term in {query}, an array of slip objects is returned inside a search object.
+
+    Args:
+        query (string): The search query provided.
+    \"\"\"
+
+Function:
+def ask_to_user(question:str):
+    \"\"\"
+    You can ask user for guidance when you think you need more information to handle the task, but you should use this tool as less as you can.
+
+    Args:
+        question (string): The question you want to ask to user.
+    \"\"\"
+
+Function:
+def finish(answer:str):
+    \"\"\"
+    Finish the task and give your answer.
+
+    Args:
+        answer (string): Your answer for the task.
+    \"\"\"
+
+"
     },
     {
         "role": "User",
@@ -48,7 +95,9 @@ The data needs to be organized in the following format:
 The chat template is:
 
 ```jinja
-{% for message in messages %}{{message['role'] + ': ' + message['content']}}{% if loop.last %}{% if add_generation_prompt %}{{ '\nAssistant:' }}{% else %}{{ '</s>'}}{% endif %}{% else %}{{ '\n' }}{% endif %}{% endfor %}
+{% for message in messages %}{{message['role'] + ': ' + message['content']}}{% if loop.last %}{% if add_generation_prompt %}{{ '
+Assistant:' }}{% else %}{{ '</s>'}}{% endif %}{% else %}{{ '
+' }}{% endif %}{% endfor %}
 ```
 
 ## Inference
@@ -61,7 +110,49 @@ model_path = "Junjie-Ye/TL-CodeLLaMA-2"
 data = [
     {
         "role": "System",
-        "content": "Function:\ndef random_advice():\n    \"\"\"\n    Returns a random advice slip as a slip object.\n    \"\"\"\n\nFunction:\ndef advice_by_id(slip_id:str):\n    \"\"\"\n    If an advice slip is found with the corresponding {slip_id}, a slip object is returned.\n\n    Args:\n        slip_id (string): The unique ID of this advice slip.\n    \"\"\"\n\nFunction:\ndef search_advice(query:str):\n    \"\"\"\n    If an advice slip is found, containing the corresponding search term in {query}, an array of slip objects is returned inside a search object.\n\n    Args:\n        query (string): The search query provided.\n    \"\"\"\n\nFunction:\ndef ask_to_user(question:str):\n    \"\"\"\n    You can ask user for guidance when you think you need more information to handle the task, but you should use this tool as less as you can.\n\n    Args:\n        question (string): The question you want to ask to user.\n    \"\"\"\n\nFunction:\ndef finish(answer:str):\n    \"\"\"\n    Finish the task and give your answer.\n\n    Args:\n        answer (string): Your answer for the task.\n    \"\"\"\n\n"
+        "content": "Function:
+def random_advice():
+    \"\"\"
+    Returns a random advice slip as a slip object.
+    \"\"\"
+
+Function:
+def advice_by_id(slip_id:str):
+    \"\"\"
+    If an advice slip is found with the corresponding {slip_id}, a slip object is returned.
+
+    Args:
+        slip_id (string): The unique ID of this advice slip.
+    \"\"\"
+
+Function:
+def search_advice(query:str):
+    \"\"\"
+    If an advice slip is found, containing the corresponding search term in {query}, an array of slip objects is returned inside a search object.
+
+    Args:
+        query (string): The search query provided.
+    \"\"\"
+
+Function:
+def ask_to_user(question:str):
+    \"\"\"
+    You can ask user for guidance when you think you need more information to handle the task, but you should use this tool as less as you can.
+
+    Args:
+        question (string): The question you want to ask to user.
+    \"\"\"
+
+Function:
+def finish(answer:str):
+    \"\"\"
+    Finish the task and give your answer.
+
+    Args:
+        answer (string): Your answer for the task.
+    \"\"\"
+
+"
     },
     {
         "role": "User",
@@ -69,7 +160,9 @@ data = [
     }
 ]
 
-chat_template = "{% for message in messages %}{{message['role'] + ': ' + message['content']}}{% if loop.last %}{% if add_generation_prompt %}{{ '\nAssistant:' }}{% else %}{{ '</s>'}}{% endif %}{% else %}{{ '\n' }}{% endif %}{% endfor %}"
+chat_template = "{% for message in messages %}{{message['role'] + ': ' + message['content']}}{% if loop.last %}{% if add_generation_prompt %}{{ '
+Assistant:' }}{% else %}{{ '</s>'}}{% endif %}{% else %}{{ '
+' }}{% endif %}{% endfor %}"
 
 model = AutoModelForCausalLM.from_pretrained(
     model_path,
@@ -119,4 +212,4 @@ If you find this model useful in your research, please cite:
       primaryClass={cs.CL},
       url={https://arxiv.org/abs/2412.15495}, 
 }
-```
+```