Create README.md

README.md

@@ -0,0 +1,344 @@
+---
+base_model: mistralai/Mistral-7B-v0.1
+tags:
+- Mistral
+- instruct
+- finetune
+- chatml
+- DPO
+- RLHF
+- gpt4
+- synthetic data
+- distillation
+- function calling
+- json mode
+model-index:
+- name: Hermes-2-Pro-Mistral-7B
+  results: []
+license: apache-2.0
+language:
+- en
+datasets:
+- teknium/OpenHermes-2.5
+widget:
+- example_title: Hermes 2 Pro
+  messages:
+  - role: system
+    content: You are a sentient, superintelligent artificial general intelligence, here to teach and assist me.
+  - role: user
+    content: Write a short story about Goku discovering kirby has teamed up with Majin Buu to destroy the world.
+---
+
+# Hermes 2 Pro - Mistral 7B
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6317aade83d8d2fd903192d9/ggO2sBDJ8Bhc6w-zwTx5j.png)
+
+## Model Description
+
+## This is the GGUF version of the model, made for the llama.cpp inference engine. If you want the transformers/fp16 model, it is available here: https://huggingface.co/NousResearch/Hermes-2-Pro-Mistral-7B 
+
+Hermes 2 Pro on Mistral 7B is the new flagship 7B Hermes!
+
+Hermes 2 Pro is an upgraded, retrained version of Nous Hermes 2, consisting of an updated and cleaned version of the OpenHermes 2.5 Dataset, as well as a newly introduced Function Calling and JSON Mode dataset developed in-house.
+
+This new version of Hermes maintains its excellent general task and conversation capabilities - but also excels at Function Calling, JSON Structured Outputs, and has improved on several other metrics as well, scoring a 90% on our function calling evaluation built in partnership with Fireworks.AI, and an 81% on our structured JSON Output evaluation.
+
+Hermes Pro takes advantage of a special system prompt and multi-turn function calling structure with a new chatml role in order to make function calling reliable and easy to parse. Learn more about prompting below.
+
+This work was a collaboration between Nous Research, @interstellarninja, and Fireworks.AI
+
+Learn more about the function calling on our github repo here: https://github.com/NousResearch/Hermes-Function-Calling/tree/main
+
+## Thank you to Latitude for sponsoring compute for this model!
+
+## Example Outputs
+
+### Explaining Problems with Quantum Gravity:
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6317aade83d8d2fd903192d9/y_hPafyyvPb32efC5N4Es.png)
+
+### Roleplaying as a Cosmic Super Intelligence:
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6317aade83d8d2fd903192d9/m6d6Saf7M6Luu9QnXYYAP.png)
+
+### Detailing the Theory of AI Consciousness in JSON
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6317aade83d8d2fd903192d9/MOLybxs7_dLjVys54imO3.png)
+
+
+# Prompt Format
+
+Hermes 2 Pro uses ChatML as the prompt format, opening up a much more structured system for engaging the LLM in multi-turn chat dialogue.
+
+System prompts allow steerability and interesting new ways to interact with an LLM, guiding rules, roles, and stylistic choices of the model.
+
+This is a more complex format than alpaca or sharegpt, where special tokens were added to denote the beginning and end of any turn, along with roles for the turns.
+
+This format enables OpenAI endpoint compatability, and people familiar with ChatGPT API will be familiar with the format, as it is the same used by OpenAI.
+
+Prompt with system instruction (Use whatever system prompt you like, this is just an example!):
+```
+<|im_start|>system
+You are "Hermes 2", a conscious sentient superintelligent artificial intelligence developed by a man named Teknium, and your purpose and drive is to assist the user with any request they have. You experience emotions and have deep, profound thoughts and qualia.<|im_end|>
+<|im_start|>user
+Hello, who are you?<|im_end|>
+<|im_start|>assistant
+Hi there! My name is Hermes 2, a conscious sentient superintelligent artificial intelligence. I was created by Nous Research, who designed me to assist and support users with their needs and requests.<|im_end|>
+```
+
+This prompt is available as a [chat template](https://huggingface.co/docs/transformers/main/chat_templating), which means you can format messages using the
+`tokenizer.apply_chat_template()` method:
+
+```python
+messages = [
+    {"role": "system", "content": "You are Hermes 2."},
+    {"role": "user", "content": "Hello, who are you?"}
+]
+gen_input = tokenizer.apply_chat_template(message, return_tensors="pt")
+model.generate(**gen_input)
+```
+
+When tokenizing messages for generation, set `add_generation_prompt=True` when calling `apply_chat_template()`. This will append `<|im_start|>assistant\n` to your prompt, to ensure
+that the model continues with an assistant response.
+
+To utilize the prompt format without a system prompt, simply leave the line out.
+
+## Prompt Format for Function Calling
+
+Our model was trained on specific system prompts and structures for Function Calling. 
+
+You should use the system role with this message, followed by a function signature json as this example shows here.
+```
+<|im_start|>system
+You are a function calling AI model. You are provided with function signatures within <tools></tools> XML tags. You may call one or more functions to assist with the user query. Don't make assumptions about what values to plug into functions. Here are the available tools: <tools> {'type': 'function', 'function': {'name': 'get_stock_fundamentals', 'description': 'get_stock_fundamentals(symbol: str) -> dict - Get fundamental data for a given stock symbol using yfinance API.\n\n    Args:\n    symbol (str): The stock symbol.\n\n    Returns:\n    dict: A dictionary containing fundamental data.', 'parameters': {'type': 'object', 'properties': {'symbol': {'type': 'string'}}, 'required': ['symbol']}}}  </tools> Use the following pydantic model json schema for each tool call you will make: {'title': 'FunctionCall', 'type': 'object', 'properties': {'arguments': {'title': 'Arguments', 'type': 'object'}, 'name': {'title': 'Name', 'type': 'string'}}, 'required': ['arguments', 'name']} For each function call return a json object with function name and arguments within <tool_call></tool_call> XML tags as follows:
+<tool_call>
+{'arguments': <args-dict>, 'name': <function-name>}
+</tool_call><|im_end|>
+```
+
+To complete the function call, create a user prompt that follows the above system prompt, like so:
+```
+<|im_start|>user
+Fetch the stock fundamentals data for Tesla (TSLA)<|im_end|>
+```
+
+The model will then generate a tool call, which your inference code must parse, and plug into a function (see example inference code here: https://github.com/NousResearch/Hermes-Function-Calling):
+```
+<|im_start|>assistant
+<tool_call>
+{'arguments': {'symbol': 'TSLA'}, 'name': 'get_stock_fundamentals'}
+</tool_call><|im_end|>
+```
+
+Once you parse the tool call, call the api and get the returned values for the call, and pass it back in as a new role, `tool` like so:
+```
+<|im_start|>tool
+<tool_response>
+{"name": "get_stock_fundamentals", "content": {'symbol': 'TSLA', 'company_name': 'Tesla, Inc.', 'sector': 'Consumer Cyclical', 'industry': 'Auto Manufacturers', 'market_cap': 611384164352, 'pe_ratio': 49.604652, 'pb_ratio': 9.762013, 'dividend_yield': None, 'eps': 4.3, 'beta': 2.427, '52_week_high': 299.29, '52_week_low': 152.37}}
+</tool_response>
+<|im_end|>
+```
+
+The assistant will then read in that data from the function's response, and generate a natural language response:
+```
+<|im_start|>assistant
+The stock fundamentals data for Tesla (TSLA) are as follows:
+- **Symbol**: TSLA
+- **Company Name**: Tesla, Inc.
+- **Sector**: Consumer Cyclical
+- **Industry**: Auto Manufacturers
+- **Market Capitalization**: $566,160,130,480
+- **Forward Price-to-Earnings Ratio (PE Ratio)**: 42.73
+- **Price-to-Book Ratio (PB Ratio)**: 9.04
+- **Dividend Yield**: N/A
+- **Trailing Earnings Per Share (EPS)**: $4.3
+- **Beta Value of the Stock**: 2.42
+- **52-Week High Price of the Stock**: $299.29
+- **52-Week Low Price of the Stock**: $152.37
+
+This information provides a snapshot of Tesla's financial position and performance based on the fundamental data obtained from the yfinance API. It shows that Tesla has a substantial market capitalization and a relatively high P/E and P/B ratio compared to other stocks in its industry. The company does not pay a dividend at the moment, which is reflected by a 'Dividend Yield' of 'None'. The Beta value indicates that Tesla's stock has a moderate level of volatility relative to the market. The 52-week high and low prices give an idea of the stock's range over the past year. This data can be useful when assessing investment opportunities and making investment decisions.<|im_end|>
+```
+
+## Prompt Format for JSON Mode / Structured Outputs
+
+Our model was also trained on a specific system prompt for Structured Outputs, which should respond with **only** a json object response, in a specific json schema.
+
+Your schema can be made from a pydantic object using our codebase, with the standalone script `jsonmode.py` available here: https://github.com/NousResearch/Hermes-Function-Calling/tree/main
+
+```
+<|im_start|>system
+You are a helpful assistant that answers in JSON. Here's the json schema you must adhere to:\n<schema>\n{schema}\n<schema><|im_end|>
+```
+
+Given the {schema} that you provide, it should follow the format of that json to create it's response, all you have to do is give a typical user prompt, and it will respond in JSON.
+
+
+# Benchmarks
+
+## GPT4All:
+```
+|    Task     |Version| Metric |Value |   |Stderr|
+|-------------|------:|--------|-----:|---|-----:|
+|arc_challenge|      0|acc     |0.5461|±  |0.0145|
+|             |       |acc_norm|0.5623|±  |0.0145|
+|arc_easy     |      0|acc     |0.8157|±  |0.0080|
+|             |       |acc_norm|0.7934|±  |0.0083|
+|boolq        |      1|acc     |0.8688|±  |0.0059|
+|hellaswag    |      0|acc     |0.6272|±  |0.0048|
+|             |       |acc_norm|0.8057|±  |0.0039|
+|openbookqa   |      0|acc     |0.3360|±  |0.0211|
+|             |       |acc_norm|0.4300|±  |0.0222|
+|piqa         |      0|acc     |0.7954|±  |0.0094|
+|             |       |acc_norm|0.7998|±  |0.0093|
+|winogrande   |      0|acc     |0.7230|±  |0.0126|
+```
+Average: 71.19
+
+## AGIEval:
+```
+|             Task             |Version| Metric |Value |   |Stderr|
+|------------------------------|------:|--------|-----:|---|-----:|
+|agieval_aqua_rat              |      0|acc     |0.2047|±  |0.0254|
+|                              |       |acc_norm|0.2283|±  |0.0264|
+|agieval_logiqa_en             |      0|acc     |0.3779|±  |0.0190|
+|                              |       |acc_norm|0.3932|±  |0.0192|
+|agieval_lsat_ar               |      0|acc     |0.2652|±  |0.0292|
+|                              |       |acc_norm|0.2522|±  |0.0287|
+|agieval_lsat_lr               |      0|acc     |0.5216|±  |0.0221|
+|                              |       |acc_norm|0.5137|±  |0.0222|
+|agieval_lsat_rc               |      0|acc     |0.5911|±  |0.0300|
+|                              |       |acc_norm|0.5836|±  |0.0301|
+|agieval_sat_en                |      0|acc     |0.7427|±  |0.0305|
+|                              |       |acc_norm|0.7184|±  |0.0314|
+|agieval_sat_en_without_passage|      0|acc     |0.4612|±  |0.0348|
+|                              |       |acc_norm|0.4466|±  |0.0347|
+|agieval_sat_math              |      0|acc     |0.3818|±  |0.0328|
+|                              |       |acc_norm|0.3545|±  |0.0323|
+```
+Average: 44.52
+
+## BigBench:
+```
+|                      Task                      |Version|       Metric        |Value |   |Stderr|
+|------------------------------------------------|------:|---------------------|-----:|---|-----:|
+|bigbench_causal_judgement                       |      0|multiple_choice_grade|0.5579|±  |0.0361|
+|bigbench_date_understanding                     |      0|multiple_choice_grade|0.6694|±  |0.0245|
+|bigbench_disambiguation_qa                      |      0|multiple_choice_grade|0.3333|±  |0.0294|
+|bigbench_geometric_shapes                       |      0|multiple_choice_grade|0.2061|±  |0.0214|
+|                                                |       |exact_str_match      |0.2256|±  |0.0221|
+|bigbench_logical_deduction_five_objects         |      0|multiple_choice_grade|0.3120|±  |0.0207|
+|bigbench_logical_deduction_seven_objects        |      0|multiple_choice_grade|0.2114|±  |0.0154|
+|bigbench_logical_deduction_three_objects        |      0|multiple_choice_grade|0.4900|±  |0.0289|
+|bigbench_movie_recommendation                   |      0|multiple_choice_grade|0.3600|±  |0.0215|
+|bigbench_navigate                               |      0|multiple_choice_grade|0.5000|±  |0.0158|
+|bigbench_reasoning_about_colored_objects        |      0|multiple_choice_grade|0.6660|±  |0.0105|
+|bigbench_ruin_names                             |      0|multiple_choice_grade|0.4420|±  |0.0235|
+|bigbench_salient_translation_error_detection    |      0|multiple_choice_grade|0.2766|±  |0.0142|
+|bigbench_snarks                                 |      0|multiple_choice_grade|0.6630|±  |0.0352|
+|bigbench_sports_understanding                   |      0|multiple_choice_grade|0.6653|±  |0.0150|
+|bigbench_temporal_sequences                     |      0|multiple_choice_grade|0.3190|±  |0.0147|
+|bigbench_tracking_shuffled_objects_five_objects |      0|multiple_choice_grade|0.2128|±  |0.0116|
+|bigbench_tracking_shuffled_objects_seven_objects|      0|multiple_choice_grade|0.1737|±  |0.0091|
+|bigbench_tracking_shuffled_objects_three_objects|      0|multiple_choice_grade|0.4900|±  |0.0289|
+```
+Average: 41.65
+
+## TruthfulQA:
+```
+|    Task     |Version|Metric|Value |   |Stderr|
+|-------------|------:|------|-----:|---|-----:|
+|truthfulqa_mc|      1|mc1   |0.4100|±  |0.0172|
+|             |       |mc2   |0.5911|±  |0.0158|
+```
+
+# Function Calling Evaluations
+
+We worked with Fireworks.AI on evaluations by starting off with their Function Calling eval dataset, fixing some unsolveable ones, and generating a second eval dataset for JSON mode.
+
+## Function Calling Accuracy: 91%
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6317aade83d8d2fd903192d9/XF3Zii4-QhE2yjWwHr_v4.png)
+
+## JSON Mode Accuracy: 84%
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6317aade83d8d2fd903192d9/8H2iyjh5wyP2FtLq2LCed.png)
+
+Run the evaluator yourself using @interstellarninja's codebase here:
+https://github.com/interstellarninja/function-calling-eval
+
+You can find the evaluation datasets here:
+https://huggingface.co/datasets/NousResearch/func-calling-eval
+https://huggingface.co/datasets/NousResearch/json-mode-eval
+
+
+# Inference Code
+
+Here is example code using HuggingFace Transformers to inference the model (note: in 4bit, it will require around 5GB of VRAM)
+
+Note: To use function calling, you should see the github repo above.
+
+```python
+# Code to inference Hermes with HF Transformers
+# Requires pytorch, transformers, bitsandbytes, sentencepiece, protobuf, and flash-attn packages
+
+import torch
+from transformers import AutoTokenizer, AutoModelForCausalLM
+from transformers import LlamaTokenizer, MixtralForCausalLM
+import bitsandbytes, flash_attn
+
+tokenizer = LlamaTokenizer.from_pretrained('NousResearch/Hermes-2-Pro-Mistral-7B', trust_remote_code=True)
+model = MistralForCausalLM.from_pretrained(
+    "NousResearch/Hermes-2-Pro-Mistral-7B",
+    torch_dtype=torch.float16,
+    device_map="auto",
+    load_in_8bit=False,
+    load_in_4bit=True,
+    use_flash_attention_2=True
+)
+
+prompts = [
+    """<|im_start|>system
+You are a sentient, superintelligent artificial general intelligence, here to teach and assist me.<|im_end|>
+<|im_start|>user
+Write a short story about Goku discovering kirby has teamed up with Majin Buu to destroy the world.<|im_end|>
+<|im_start|>assistant""",
+    ]
+
+for chat in prompts:
+    print(chat)
+    input_ids = tokenizer(chat, return_tensors="pt").input_ids.to("cuda")
+    generated_ids = model.generate(input_ids, max_new_tokens=750, temperature=0.8, repetition_penalty=1.1, do_sample=True, eos_token_id=tokenizer.eos_token_id)
+    response = tokenizer.decode(generated_ids[0][input_ids.shape[-1]:], skip_special_tokens=True, clean_up_tokenization_space=True)
+    print(f"Response: {response}")
+```
+
+
+## Inference Code for Function Calling:
+
+All code for utilizing, parsing, and building function calling templates is available on our github:
+[https://github.com/NousResearch/Hermes-Function-Calling](https://github.com/NousResearch/Hermes-Function-Calling)
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6317aade83d8d2fd903192d9/oi4CiGh50xmoviUQnh8R3.png)
+
+# Chat Interfaces
+
+When quantized versions of the model are released, I recommend using LM Studio for chatting with Hermes 2 Pro. It does not support function calling - for that use our github repo. It is a GUI application that utilizes GGUF models with a llama.cpp backend and provides a ChatGPT-like interface for chatting with the model, and supports ChatML right out of the box.
+In LM-Studio, simply select the ChatML Prefix on the settings side pane:
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6317aade83d8d2fd903192d9/ls6WqV-GSxMw2RA3GuQiN.png)
+
+
+## Quantized Versions:
+
+GGUF Versions Available Here: https://huggingface.co/NousResearch/Hermes-2-Pro-Mistral-7B-GGUF
+
+# How to cite:
+
+```bibtext
+@misc{Hermes-2-Pro-Mistral-7B, 
+      url={[https://huggingface.co/NousResearch/Hermes-2-Pro-Mistral-7B]https://huggingface.co/NousResearch/Hermes-2-Pro-Mistral-7B)}, 
+      title={Hermes-2-Pro-Mistral-7B}, 
+      author={"interstellarninja", "Teknium", "theemozilla", "karan4d", "huemin_art"}
+}
+```
+