jayr014 commited on
Commit
1693468
1 Parent(s): 20cd870

changing 1 prompt and 1 example completion, adding in ack at bottom and changing heading for limitations and rail restrictions

Browse files
Files changed (1) hide show
  1. README.md +27 -18
README.md CHANGED
@@ -29,7 +29,8 @@ BLOOMChat is [BigScience Group BLOOM model](https://huggingface.co/bigscience/bl
29
  - **Blog Post**: [More Information Needed]
30
 
31
  ## Uses
32
-
 
33
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
34
 
35
  ### Direct Use
@@ -52,14 +53,15 @@ Bloom chat should NOT be used for:
52
 
53
  This model is still in early development and can be prone to mistakes and hallucinations, there is still room for improvement. This model is intended to provide the community with a good baseline.
54
 
55
-
56
-
57
  ### Recommendations
58
 
59
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
60
 
61
  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.
62
 
 
 
 
63
  ---
64
  ## How to Get Started with the Model
65
 
@@ -75,6 +77,18 @@ tokenizer = AutoTokenizer.from_pretrained("sambanovasystems/BLOOMChat-176B-v1")
75
  model = AutoModelForCausalLM.from_pretrained("sambanovasystems/BLOOMChat-176B-v1", device_map="auto", torch_dtype="auto")
76
  ```
77
 
 
 
 
 
 
 
 
 
 
 
 
 
78
 
79
  ### Suggested Inference Parameters
80
  - Temperature: 0.8
@@ -94,9 +108,7 @@ model = AutoModelForCausalLM.from_pretrained("sambanovasystems/BLOOMChat-176B-v1
94
  ```
95
 
96
  ```
97
- <human>: Answer the following question using the context below:
98
- Q: Which regulatory body is invovled?
99
- Context: U.S. authorities launched emergency measures on Sunday to shore up confidence in the banking system after the failure of Silicon Valley Bank (SIVB.O) threatened to trigger a broader financial crisis. After a dramatic weekend, regulators said the failed bank’s customers will have access to all their deposits starting Monday and set up a new facility to give banks access to emergency funds. The Federal Reserve also made it easier for banks to borrow from it in emergencies. While the measures provided some relief for Silicon Valley firms and global markets on Monday, worries about broader banking risks remain and have cast doubts over whether the Fed will stick with its plan for aggressive interest rate hikes.
100
  <bot>:
101
  ```
102
 
@@ -132,17 +144,11 @@ Details:
132
  ```
133
 
134
  ```
135
- <human>: Explain the difference between a proton and a neutron
136
- <bot>: A proton and a neutron are both subatomic particles, but they differ in several ways:
 
 
137
 
138
- 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.
139
-
140
- Charge: A proton has a positive charge, while a neutron has no charge.
141
-
142
- Spinning: Protons and neutrons both have a spinning motion called intrinsic spin, but the direction of their spin is opposite to each other.
143
-
144
- Protons are found in the nucleus of atoms, while neutrons are found in the nucleus of atoms.
145
- In the nucleus of atoms, protons and neutrons are bound together in a structure called a nucleus, which gives the atom its stability.
146
  ```
147
 
148
  </details>
@@ -246,7 +252,7 @@ We trained BLOOMChat with SambaStudio, a platform built on SambaNova's in-house
246
 
247
  ---
248
 
249
- ### RAIL Restrictions
250
 
251
  As the original model [BLOOM](https://huggingface.co/bigscience/bloom) is on the RAIL License, we need to follow the same restrictions.
252
 
@@ -265,7 +271,7 @@ You agree not to use the Model or Derivatives of the Model:
265
  12. To provide medical advice and medical results interpretation;
266
  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).
267
 
268
- ### Bias, Risks, and Limitations
269
 
270
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
271
 
@@ -276,4 +282,7 @@ Like all LLMs, BLOOMChat has certain limitations:
276
  - Coding and Math: The model's performance in generating accurate code or solving complex mathematical problems may be limited.
277
  - Toxicity: BLOOMChat may inadvertently generate responses containing inappropriate or harmful content.
278
 
 
 
 
279
 
 
29
  - **Blog Post**: [More Information Needed]
30
 
31
  ## Uses
32
+ <details>
33
+ <summary>Click to expand</summary>
34
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
35
 
36
  ### Direct Use
 
53
 
54
  This model is still in early development and can be prone to mistakes and hallucinations, there is still room for improvement. This model is intended to provide the community with a good baseline.
55
 
 
 
56
  ### Recommendations
57
 
58
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
59
 
60
  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.
61
 
62
+ </details>
63
+
64
+
65
  ---
66
  ## How to Get Started with the Model
67
 
 
77
  model = AutoModelForCausalLM.from_pretrained("sambanovasystems/BLOOMChat-176B-v1", device_map="auto", torch_dtype="auto")
78
  ```
79
 
80
+ ### Tutorial on using the model for text generation
81
+
82
+ [Transformers BLOOM Inference](https://github.com/huggingface/transformers-bloom-inference)
83
+
84
+ Specifically we tested BLOOM inference via command-line in this repository.
85
+
86
+ NOTE: Things that we had to modify in order for BLOOMChat to work:
87
+ - Install transformers version 4.27.0
88
+ - `pip install transformers==4.27.0`
89
+ - Change the model name from `bigscience/bloom` to `sambanovasystems/BLOOMChat-176B-v1`
90
+
91
+
92
 
93
  ### Suggested Inference Parameters
94
  - Temperature: 0.8
 
108
  ```
109
 
110
  ```
111
+ <human>: Create an itemized list of tasks to complete to start a clothing brand
 
 
112
  <bot>:
113
  ```
114
 
 
144
  ```
145
 
146
  ```
147
+ <human>: What is artificial intelligence? Explain it so an 8 year old will understand.
148
+ <bot>: Artificial Intelligence (AI) is a computer program or machine that can do things that would normally require human intelligence, such as recognizing patterns, making decisions, and learning from experience. AI can be found in many places, such as self-driving cars, smartphones, and even robots. AI is used to make things easier for people, like when your smartphone can translate text into another language or when your voice-controlled speaker can play music for you.
149
+ AI works by using algorithms and big data to learn and improve over time. For example, self-driving cars use AI to analyze the environment around them and make decisions about how to drive. The car gathers data from its sensors, processes it using algorithms, and adjusts its behavior accordingly. This process is called machine learning.
150
+ AI is still a developing technology, and there are still many things that AI programs cannot do yet. However, as AI continues to evolve, it is likely that it will become more and more capable of performing tasks that were once thought to require human intelligence.
151
 
 
 
 
 
 
 
 
 
152
  ```
153
 
154
  </details>
 
252
 
253
  ---
254
 
255
+ ## RAIL Restrictions
256
 
257
  As the original model [BLOOM](https://huggingface.co/bigscience/bloom) is on the RAIL License, we need to follow the same restrictions.
258
 
 
271
  12. To provide medical advice and medical results interpretation;
272
  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).
273
 
274
+ ## Bias, Risks, and Limitations
275
 
276
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
277
 
 
282
  - Coding and Math: The model's performance in generating accurate code or solving complex mathematical problems may be limited.
283
  - Toxicity: BLOOMChat may inadvertently generate responses containing inappropriate or harmful content.
284
 
285
+ ## Acknowledgment
286
+
287
+ We would like to extend our gratitude to Together for their insightful technical discussions on overall project planning, data processing, model training, human evaluation experiment design, open-source endeavors, and their contributions on data processing code on OpenChatKit, OASST1, and Dolly 2.0.
288