Gorilla OpenFunctions

README.md

@@ -3,6 +3,8 @@
 
 <img src="https://github.com/ShishirPatil/gorilla/blob/gh-pages/assets/img/logo.png" width=50% height=50%>
 
+**:fire: Gorilla OpenFunctions** is a drop-in alternative for function calling! [Release Blog](https://gorilla.cs.berkeley.edu/blogs/4_open_functions.html)
+
 **🟢 Gorilla is Apache 2.0** With Gorilla being fine-tuned on MPT, and Falcon, you can use Gorilla commercially with no obligations! :golf:  
 
 **:rocket: Try Gorilla in 60s** [![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1DEBPsccVLF_aUnmD0FwPeHFrtdC0QIUP?usp=sharing) 
@@ -17,6 +19,7 @@
 `Gorilla` enables LLMs to use tools by invoking APIs. Given a natural language query, Gorilla comes up with the semantically- and syntactically- correct API to invoke. With Gorilla, we are the first to demonstrate how to use LLMs to invoke 1,600+ (and growing) API calls accurately while reducing hallucination. We also release APIBench, the largest collection of APIs, curated and easy to be trained on! Join us, as we try to expand the largest API store and teach LLMs how to write them! Hop on our Discord, or open a PR, or email us if you would like to have your API incorporated as well.
 
 ## News
+- :fire: [11/16] Excited to release [Gorilla OpenFunctions](https://gorilla.cs.berkeley.edu/blogs/4_open_functions.html)
 - 💻 [06/29] Released [gorilla-cli](https://github.com/gorilla-llm/gorilla-cli), LLMs for your CLI!
 - 🟢 [06/06] Released Commercially usable, Apache 2.0 licensed Gorilla models
 - :rocket: [05/30] Provided the [CLI interface](inference/README.md) to chat with Gorilla!

openfunctions/README.md

@@ -0,0 +1,79 @@
+# Gorilla Openfunctions
+
+💡 Comes with Parallel Function Calling!  
+🚀 Try it out on [Colab](https://colab.research.google.com/drive/16M5J2H9F8YQora_W2PDnp120slZH-Mqd?usp=sharing)   
+📣 Read more in our [OpenFunctions release blog](https://gorilla.cs.berkeley.edu/blogs/4_open_functions.html)
+
+## Introduction
+Gorilla OpenFunctions extends Large Language Model(LLM) Chat Completion feature to formulate 
+executable APIs call given natural language instructions and API context.
+
+## Models Available
+|Model | Functionality|
+|---|---|
+|gorilla-openfunctions-v0 | Given a function, and user intent, returns properly formatted json with the right arguments|
+|gorilla-openfunctions-v1 | + Parallel functions, and can choose between functions|
+
+All of our models are hosted on our Huggingface UC Berkeley gorilla-llm org: [gorilla-openfunctions-v0](https://huggingface.co/gorilla-llm/gorilla-openfunctions-v0) and [gorilla-openfunctions-v1](https://huggingface.co/gorilla-llm/gorilla-openfunctions-v1).
+
+## Example Usage
+
+1. OpenFunctions is compatible with OpenAI Functions
+
+```bash
+!pip install openai==0.28.1
+```
+
+2. Point to Gorilla hosted servers
+
+```python
+import openai
+
+def get_gorilla_response(prompt="Call me an Uber ride type \"Plus\" in Berkeley at zipcode 94704 in 10 minutes", model="gorilla-openfunctions-v0", functions=[]):
+  openai.api_key = "EMPTY"
+  openai.api_base = "http://luigi.millennium.berkeley.edu:8000/v1"
+  try:
+    completion = openai.ChatCompletion.create(
+      model="gorilla-openfunctions-v1",
+      temperature=0.0,
+      messages=[{"role": "user", "content": prompt}],
+      functions=functions,
+    )
+    return completion.choices[0].message.content
+  except Exception as e:
+    print(e, model, prompt)
+```
+
+3. Pass the user argument and set of functions, Gorilla OpenFunctions returns a fully formatted json
+
+```python
+query = "Call me an Uber ride type \"Plus\" in Berkeley at zipcode 94704 in 10 minutes"
+functions = [
+    {
+        "name": "Uber Carpool",
+        "api_name": "uber.ride",
+        "description": "Find suitable ride for customers given the location, type of ride, and the amount of time the customer is willing to wait as parameters",
+        "parameters":  [{"name": "loc", "description": "location of the starting place of the uber ride"}, {"name":"type", "enum": ["plus", "comfort", "black"], "description": "types of uber ride user is ordering"}, {"name": "time", "description": "the amount of time in minutes the customer is willing to wait"}]
+    }
+]
+get_gorilla_response(query, functions=functions)
+```
+
+4. Expected output
+
+```bash
+uber.ride(loc="berkeley", type="plus", time=10)
+```
+
+## Evaluation
+
+<img src="https://github.com/ShishirPatil/gorilla/blob/gh-pages/assets/img/blog_post_4_OpenFunctions_Distribution.png" width=50% height=50%>
+
+
+
+## Contributing
+
+All the models, and data used to train the models is released under Apache 2.0.
+Gorilla is an open source effort from UC Berkeley and we welcome contributors. 
+Please email us your comments, criticism, and questions. More information about the project can be found at [https://gorilla.cs.berkeley.edu/](https://gorilla.cs.berkeley.edu/)
+