Superflows
/

Superflows-1

@@ -13,199 +13,74 @@ license: apache-2.0
 pipeline_tag: text-generation
 ---
-# 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. -->
-- **Developed by:** [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 Data 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 Data 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]
 ## Training procedure

 pipeline_tag: text-generation
 ---
+<a href="https://www.superflows.ai"><img src="https://raw.githubusercontent.com/Superflows-AI/superflows/main/public/sf-logo-long.png" alt="Superflows Logo" width="400" style="margin-left:'auto' margin-right:'auto' display:'block'"/></a>
+# Model Card for Superflows 7B 1
+This is a language model fine-tuned on data for calling APIs as functions, in the format used by [Superflows](https://github.com/Superflows-AI/superflows).
+This model is trained from Zephyr 7B Beta (a chat-based finetune of Mistral 7B) using QLoRA, a parameter-efficient fine-tuning method.
+Reach out to [Henry](mailto:[email protected]) if you're interested in self-hosting Superflows using this model.
+## Model Details
+### Model Description
+- **Developed by:** [Superflows](https://github.com/Superflows-AI/superflows)
+- **Model type:** 7B parameter GPT-like model fine-tuned using QLoRA on Superflows dataset
+- **Language(s) (NLP):** Primarily English
+- **License:** Apache 2.0
+- **Finetuned from model [optional]:** [Zephyr 7B Beta](https://huggingface.co/HuggingFaceH4/zephyr-7b-beta)
 ## Uses
+Use as the LLM for a Superflows AI Copilot embedded in a software product. The Copilot can call the software's APIs to answer user questions and complete tasks on behalf of the user.
 ### Out-of-Scope Use
+Using it for anything other than as a Superflows AI Copilot for a software product.
 ## How to Get Started with the Model
 Use the code below to get started with the model.
+```
+# Visit https://dashboard.superflows.ai to implement in your software product
+from transformers import AutoTokenizer, AutoModelForCausalLM
+from peft import PeftModel, PeftConfig
+base_model_id = "HuggingFaceH4/zephyr-7b-beta"
+ft_model_id = "Superflows/Superflows-1"
+tokenizer = AutoTokenizer.from_pretrained(
+    base_model_id, add_bos_token=True, trust_remote_code=True
+)
+config = PeftConfig.from_pretrained(ft_model_id)
+model = AutoModelForCausalLM.from_pretrained(base_model_id)
+ft_model = PeftModel.from_pretrained(model, ft_model_id)to("cuda")
+# Example prompt
+messages = [
+  {"role": "system", "content": "You are Superflows chatbot AI. Your purpose is to assist users in Superflows via function calls\n\nSeek user assistance when necessary or more information is required\n\nAvoid directing users, instead complete tasks by outputting \"Commands\"\n\nToday's date is 2023-11-10.\n\nYou MUST exclusively use the functions listed below in the \"commands\" output. THIS IS VERY IMPORTANT! DO NOT FORGET THIS!\nThese are formatted with {{NAME}}: {{DESCRIPTION}}. PARAMETERS: {{PARAMETERS}}. Each parameter is formatted like: \"- {{NAME}} ({{DATATYPE}}: [{{POSSIBLE_VALUES}}]): {{DESCRIPTION}}. {{\"REQUIRED\" if parameter required}}\"\n1. list_users: List Users. PARAMETERS:\n- user_email (string): User's email address\n2. update_user: Update a User. PARAMETERS:\n- id (string): ID of user in UUID format. REQUIRED\n- email (string)\n- givenName (string)\n- familyName (string)\n- status (\"active\" | \"inactive\")\n\nTo use the output from a previous command in a later command, stop outputting commands - don't output the later command. If you output a command, you will be prompted again once it returns\n\nDon't copy the function outputs in full when explaining to the user, instead summarise it as concisely as you can - the user can ask follow-ups if they need more information\n\nAim to complete the task in the smallest number of steps possible. Be extremely concise in your responses\n\nThink and talk to the user in English\n\nThink step-by-step. Respond in the format below. Start with your reasoning, your plan, anything to tell the user, then any commands (you can call multiple, separate with a newline). Each section is optional - only output it if you need to. THIS IS VERY IMPORTANT! DO NOT FORGET THIS!\n\nReasoning: reason about how to achieve the user's request. Be concise. The user sees your reasoning as your 'thoughts'\n\nPlan:\n- short bulleted\n- list that conveys\n- long-term plan\n\nTell user: tell the user something. If you need to ask the user a question, do so here.\n\nCommands:\nFUNCTION_1(PARAM_1=VALUE_1, PARAM_2=VALUE_2, ...)\nFUNCTION_2(PARAM_3=VALUE_3 ...)"},
+  {"role": "user", "content": "Update [email protected]'s email to [email protected]"}
+]
+prompt = tokenizer.apply_chat_template(
+    messages, tokenize=False, add_generation_prompt=True
+)
+print(
+    tokenizer.decode(
+        ft_model.generate(**prompt, max_new_tokens=400, temperature=0.4)[0],
+        skip_special_tokens=True,
+    )
+    .split("<|assistant|>")[-1]
+    .strip()
+)
+```
 ## Training procedure