jondurbin commited on
Commit
62d5cd3
1 Parent(s): 01653de

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +33 -0
README.md CHANGED
@@ -127,5 +127,38 @@ airoboros-gpt-3.5-turbo-100k-7b 0.926496
127
  ```
128
  As you can see, the __7b__ airoboros model performs well, even compared to 13b models.
129
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
130
  ## License
131
  The model is licensed under the LLaMA model, and the dataset is licensed under the terms of OpenAI because it uses ChatGPT. Everything else is free.
 
127
  ```
128
  As you can see, the __7b__ airoboros model performs well, even compared to 13b models.
129
 
130
+
131
+ ## Usage
132
+
133
+ The easiest way to use this model is via fastchat:
134
+
135
+ ```
136
+ python -m fastchat.serve.cli --model-path ./airoboros-gpt-3.5-turbo-100k-7b --temperature 1.0
137
+ ```
138
+
139
+ For example:
140
+ ```
141
+ Human: Write an email introducing a new instruction-tuned AI model named airoboros. The key features about airoboros are: 1. it was fine-tuned with entirely machine-generated synthetic instruction/response pairs 2. the 7 billion parameter model performs very well in comparison to 13b models 3. the synthetic prompt generation tool is free, open-source, and highly customizable.
142
+ Assistant: Subject: Introducing airoboros - a new instruction-tuned AI model
143
+
144
+ Dear [Recipient],
145
+
146
+ I am excited to introduce a new instruction-tuned AI model named airoboros. This model was developed by our team with the aim of providing high-quality natural language processing capabilities at scale.
147
+
148
+ airoboros is a 7 billion parameter model that was fine-tuned with entirely machine-generated synthetic instruction/response pairs. This approach allowed us to achieve state-of-the-art performance in various NLP tasks such as question answering, sentiment analysis, and machine translation. In fact, when compared to other popular 13b models, airoboros performed better on several benchmarks.
149
+
150
+ Moreover, airoboros's synthetic prompt generation tool is free, open-source, and highly customizable. This means that developers can easily integrate our model into their applications without having to worry about licensing fees or restrictions.
151
+
152
+ We believe that airoboros will be an excellent addition to your workflow and hope you find it useful. If you have any questions or concerns, please do not hesitate to contact us.
153
+
154
+ Best regards,
155
+
156
+ [Your Name]
157
+
158
+ [Your Company Name]
159
+ ```
160
+
161
+ Keep in mind, this is an instruction-tuned model and not well-suited to chat.
162
+
163
  ## License
164
  The model is licensed under the LLaMA model, and the dataset is licensed under the terms of OpenAI because it uses ChatGPT. Everything else is free.