Updating Readme

README.md

@@ -4,11 +4,11 @@
 license: apache-2.0
 ---
 
-# BloomChat V1.0
+# BLOOMChat V1.0
 
 <!-- Provide a quick summary of what the model is/does. -->
 
-BloomChat-v1.0 is based on [BigScience Group Bloom-176 model](https://huggingface.co/bigscience/bloom), and is instruction-tuned on a subset of 100k datapoints per data source from the [OIG dataset](https://huggingface.co/datasets/laion/OIG) provided by laion. Then aligned using [Dolly 2.0](https://huggingface.co/datasets/databricks/databricks-dolly-15k) and [Oasst1](https://huggingface.co/datasets/OpenAssistant/oasst1).
+BLOOMChat is based on [BigScience Group BLOOM model](https://huggingface.co/bigscience/bloom), and is instruction-tuned on a subset of 100k datapoints per data source from the [OIG dataset](https://huggingface.co/datasets/laion/OIG) from the [OpenChatKit](https://www.together.xyz/blog/openchatkit). Then aligned using [Dolly 2.0](https://huggingface.co/datasets/databricks/databricks-dolly-15k) and [Oasst1](https://huggingface.co/datasets/OpenAssistant/oasst1).
 
 ## Model Details
 
@@ -18,15 +18,14 @@ BloomChat-v1.0 is based on [BigScience Group Bloom-176 model](https://huggingfac
 
 - **Developed by:** [SambaNova Systems](https://sambanova.ai/) and [Together Computer](https://www.together.xyz/)
 - **Model type:** Language Model
-- **Language(s):** Multiple; see [training data from Bloom-176B](https://huggingface.co/bigscience/bloom#training-data)
-- **License:** apache-2.0
-- **Instruction Tuned from model:** [BigScience Group Bloom-176B](https://huggingface.co/bigscience/bloom)
+- **Language(s):** Multiple; see [training data from BLOOM](https://huggingface.co/bigscience/bloom#training-data)
+- **License:** apache-2.0 with RAIL restrictions
+- **Instruction Tuned from model:** [BigScience Group BLOOM](https://huggingface.co/bigscience/bloom)
 
 ### Additional Information
 
 <!-- Provide the basic links for the model. -->
-
-- **Blogpost:** [More Information Needed]
+- **Blog Post**: [More Information Needed]
 
 ## Uses
 
@@ -35,51 +34,40 @@ BloomChat-v1.0 is based on [BigScience Group Bloom-176 model](https://huggingfac
 ### Direct Use
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+This model is intended for commercial and research use.
 
-[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. -->
-
-Like all LLMs, BloomChat has certain limitations:
-- Hallucination: BloomChat may sometimes generate responses that contain plausible-sounding but factually incorrect or irrelevant information.
-- Code Switching: The model might unintentionally switch between languages or dialects within a single response, affecting the coherence and understandability of the output.
-- Repetition: BloomChat may produce repetitive phrases or sentences, leading to less engaging and informative responses.
-- Coding and Math: The model's performance in generating accurate code or solving complex mathematical problems may be limited.
-- Toxicity: BloomChat may inadvertently generate responses containing inappropriate or harmful content.
+BLOOMChat is intended for chatbot applications and may not perform well in use cases outside of the intended use. BLOOMChat should NOT be used for safety-critical applications or for making decisions that have a significant impact on individuals or society.
 
 ### 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.
+Users should be made aware of the risks, biases, limitations, and restrictions of the model, which are listed down at the bottom of the page. 
 
 ## How to Get Started with the Model
 
 Use the code below to get started with the model.
 
-[More Information Needed]
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+tokenizer = AutoTokenizer.from_pretrained("bloomchat/BloomChat")
+model = AutoModelForCausalLM.from_pretrained("bloomchat/BloomChat", device_map="auto", torch_dtype="auto")
+```
+
 
-### Suggested inference parameters
+### Suggested Inference Parameters
 - Temperature: 0.8
 - Repetition penalty: 1.2
 - Top-p: 0.9
 - Max generated tokens: 512
 
-### Suggested System Prompts
+### Suggested Prompts To Try
 ```
 <human>: Write a script in which Bob accidentally breaks his dad's guitar
 <bot>:
@@ -102,6 +90,75 @@ Context: U.S. authorities launched emergency measures on Sunday to shore up conf
 <bot>:
 ```
 
+### Some example completions
+```
+<human>: What does it mean for the Fed to raise or lower interest rates?
+<bot>: The Federal Reserve (also known as the Fed) is the central banking system of the United States.  It was created in 1913, and is an independent agency of the federal government.  The Fed has a dual mandate of maximizing employment and stabilizing prices.  The Fed sets interest rates, and can influence the money supply and the credit markets through its actions.
+
+Raising interest rates means that the Fed is trying to reduce the money supply in the economy, and is trying to discourage borrowing and encourage saving.  Lowering interest rates means that the Fed is trying to stimulate economic growth by encouraging borrowing and reducing the cost of credit.
+
+The Fed raises or lowers interest rates in order to influence the economy and achieve its goals for employment and price stability.  Interest rates are one of the primary tools that the Fed uses to achieve its goals.
+```
+
+```
+<human>: Write an engaging and well-written property listing description for selling a house. Address of the house and some of the details are given to you. Fill in the information gap with hallucinations if needed.
+
+Property Address: 412 Monterey Ave, Capitola, CA 95010
+Parking: 3 cars + a finished single car garage
+Details:
+- open floorplan
+- window with views to park/mountains
+- Kitchen with shaker cabinetry and white Calcatta quartz counters
+<bot>: This home at 412 Monterey Ave, Capitola, CA 95010 is the perfect place to call home. With its open floor plan, it provides the perfect space for entertaining guests. The kitchen is equipped with shaker cabinetry and white Calcatta quartz counters, providing the perfect space to create culinary masterpieces. The window with views to the park and mountains provide a beautiful view of the outdoors, making this home feel like a piece of paradise. The three-car garage and finished single car garage provide ample parking space, making this home a must-see for anyone looking for a new home.
+
+```
+
+```
+<human>: Generate a table summarizing the options outlined in this email. 
+
+Team, we have to make a decision on the product plan for Goocrux v2. 
+
+The first option will take us 3 weeks of development, and will achieve performance of 80ms, but means that the UI has to change. 
+
+The second option will take us 4 weeks of development, and will achieve performance of 60ms, without any UI change. 
+
+The third option will take the longest -- 6 weeks of development, will achieve performance of 30ms, without any UI change. 
+
+# Table with four columns: (1) Option ID, (2) Development time, (3) Performance, (4) Require UI Change
+<bot>: Option ID	Development time	Performance	Require UI Change
+Option 1	3 weeks	80ms	Yes
+Option 2	4 weeks	60ms	No
+Option 3	6 weeks	30ms	No
+```
+```
+<human>: Explain the difference between a proton and a neutron
+<bot>: A proton and a neutron are both subatomic particles, but they differ in several ways:
+
+Mass: A proton has a mass of approximately 1.67 x 10^-27 kilograms, while a neutron has a mass of approximately 1.67 x 10^-27 kilograms.
+
+Charge: A proton has a positive charge, while a neutron has no charge.
+
+Spinning: Protons and neutrons both have a spinning motion called intrinsic spin, but the direction of their spin is opposite to each other.
+
+Protons are found in the nucleus of atoms, while neutrons are found in the nucleus of atoms.
+In the nucleus of atoms, protons and neutrons are bound together in a structure called a nucleus, which gives the atom its stability.
+```
+## Evaluation
+
+<!-- This section describes the evaluation protocols and provides the results. -->
+
+![Human evaluation](images/Human_evaluation.png)
+<figure style="text-align:center;">
+    <figcaption><b>BLOOMChat vs Baselines Model in Human Preference Rankings</b></figcaption>
+</figure>
+<br>
+
+![Multilingual evaluation](images/Multilingual_capabilities_comparison.png)
+<figure style="text-align:center;">
+    <figcaption><b>BLOOMChat surpasses other Bloom variants and state-of-the-art open chat models in cross-lingual setting</b></figcaption>
+</figure>
+<br>
+
 ## Training Details
 
 ### Training Data
@@ -116,7 +173,7 @@ Context: U.S. authorities launched emergency measures on Sunday to shore up conf
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
-We trained BloomChat with SambaStudio, a platform built on SambaNova's in-house Reconfigurable Dataflow Unit (RDU). We started from [Bloom-176B](https://huggingface.co/bigscience/bloom), an OSS multilingual 176B GPT model pretrained by the [BigScience group](https://huggingface.co/bigscience).
+We trained BLOOMChat with SambaStudio, a platform built on SambaNova's in-house Reconfigurable Dataflow Unit (RDU). We started from [BLOOM](https://huggingface.co/bigscience/bloom), an OSS multilingual 176B GPT model pretrained by the [BigScience group](https://huggingface.co/bigscience). There was also some preprocessing done on the training datasets.
 
 ### Prompting Style Used For Training
 ```
@@ -163,21 +220,49 @@ We trained BloomChat with SambaStudio, a platform built on SambaNova's in-house
 - End Learning Ratio: 0.1
 - Weight decay: 0.1
 
+### RAIL Restrictions
 
-## Evaluation
+As the original model [BLOOM](https://huggingface.co/bigscience/bloom) is on the RAIL License, we need to follow the same restrictions.
 
-<!-- This section describes the evaluation protocols and provides the results. -->
+You agree not to use the Model or Derivatives of the Model:
+1. In any way that violates any applicable national, federal, state, local or international law or regulation;
+2. For the purpose of exploiting, harming or attempting to exploit or harm minors in any way;
+3. To generate or disseminate verifiably false information with the purpose of harming others;
+4. To generate or disseminate personal identifiable information that can be used to harm an individual;
+5. To generate or disseminate information or content, in any context (e.g. posts, articles, tweets, chatbots or other kinds of automated bots) without expressly and intelligibly disclaiming that the text is machine generated;
+6. To defame, disparage or otherwise harass others;
+7. To impersonate or attempt to impersonate others;
+8. For fully automated decision making that adversely impacts an individual’s legal rights or otherwise creates or modifies a binding, enforceable obligation;
+9. For any use intended to or which has the effect of discriminating against or harming individuals or groups based on online or offline social behavior or known or predicted personal or personality characteristics
+10. To exploit any of the vulnerabilities of a specific group of persons based on their age, social, physical or mental characteristics, in order to materially distort the behavior of a person pertaining to that group in a manner that causes or is likely to cause that person or another person physical or psychological harm;
+11. For any use intended to or which has the effect of discriminating against individuals or groups based on legally protected characteristics or categories;
+12. To provide medical advice and medical results interpretation;
+13. To generate or disseminate information for the purpose to be used for administration of justice, law enforcement, immigration or asylum processes, such as predicting an individual will commit fraud/crime commitment (e.g. by text profiling, drawing causal relationships between assertions made in documents, indiscriminate and arbitrarily-targeted use).
 
-![HELM core-scenarios](images/HELM_core-senarios_CNN+MS_Marco_WIP.png)
+### Bias, Risks, and Limitations
 
-![Multilingual scores French and hindi](images/Multilinguality_WMT-14_on_French+Hindi.png)
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-![Multilingual scores Chinese](images/Multilinguality_WMT-14_on_Simplified_Chinese.png)
+Like all LLMs, BLOOMChat has certain limitations:
+- Hallucination: BLOOMChat may sometimes generate responses that contain plausible-sounding but factually incorrect or irrelevant information.
+- Code Switching: The model might unintentionally switch between languages or dialects within a single response, affecting the coherence and understandability of the output.
+- Repetition: BLOOMChat may produce repetitive phrases or sentences, leading to less engaging and informative responses.
+- Coding and Math: The model's performance in generating accurate code or solving complex mathematical problems may be limited.
+- Toxicity: BLOOMChat may inadvertently generate responses containing inappropriate or harmful content.
 
-![Mean Win Rate on HELM](images/Open_source_model_Mean_Win_Rate_on_HELM_core_scenarios.png)
+### Misuse and Malicious Use
 
-## Community
+BLOOMChat is designed for use in chatbot applications and should not be used for any other purpose. Misuse of the model, such as using it to engage in illegal or unethical activities, is strictly prohibited and goes against the principles of the BLOOMChat community project.
 
-[Link to discord server]
+Using the model to generate content that is cruel to individuals is a misuse of this model. This includes, but is not limited to:
 
+- Generating fake news, misinformation, or propaganda
+- Promoting hate speech, discrimination, or violence against individuals or groups
+- Impersonating individuals or organizations without their consent
+- Engaging in cyberbullying or harassment
+- Defamatory content
+- Spamming or scamming
+- Sharing confidential or sensitive information without proper authorization
+- Violating the terms of use of the model or the data used to train it
+- Creating automated bots for malicious purposes such as spreading malware, phishing scams, or spamming