jayr014 commited on
Commit
b3ce6b8
1 Parent(s): 4a8be29

updating README

Browse files
Files changed (1) hide show
  1. README.md +36 -4
README.md CHANGED
@@ -43,21 +43,26 @@ This model is intended for commercial and research use.
43
 
44
  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.
45
 
 
46
  ### Recommendations
47
 
48
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
49
 
50
  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.
51
 
 
52
  ## How to Get Started with the Model
53
 
 
 
 
54
  Use the code below to get started with the model.
55
 
56
  ```python
57
  from transformers import AutoModelForCausalLM, AutoTokenizer
58
 
59
- tokenizer = AutoTokenizer.from_pretrained("bloomchat/BloomChat")
60
- model = AutoModelForCausalLM.from_pretrained("bloomchat/BloomChat", device_map="auto", torch_dtype="auto")
61
  ```
62
 
63
 
@@ -90,7 +95,15 @@ Context: U.S. authorities launched emergency measures on Sunday to shore up conf
90
  <bot>:
91
  ```
92
 
93
- ### Some example completions
 
 
 
 
 
 
 
 
94
  ```
95
  <human>: What does it mean for the Fed to raise or lower interest rates?
96
  <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.
@@ -143,7 +156,15 @@ Spinning: Protons and neutrons both have a spinning motion called intrinsic spin
143
  Protons are found in the nucleus of atoms, while neutrons are found in the nucleus of atoms.
144
  In the nucleus of atoms, protons and neutrons are bound together in a structure called a nucleus, which gives the atom its stability.
145
  ```
146
- ## Evaluation
 
 
 
 
 
 
 
 
147
 
148
  <!-- This section describes the evaluation protocols and provides the results. -->
149
 
@@ -159,8 +180,15 @@ In the nucleus of atoms, protons and neutrons are bound together in a structure
159
  </figure>
160
  <br>
161
 
 
 
 
 
162
  ## Training Details
163
 
 
 
 
164
  ### Training Data
165
 
166
  <!-- 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. -->
@@ -220,6 +248,10 @@ We trained BLOOMChat with SambaStudio, a platform built on SambaNova's in-house
220
  - End Learning Ratio: 0.1
221
  - Weight decay: 0.1
222
 
 
 
 
 
223
  ### RAIL Restrictions
224
 
225
  As the original model [BLOOM](https://huggingface.co/bigscience/bloom) is on the RAIL License, we need to follow the same restrictions.
 
43
 
44
  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.
45
 
46
+
47
  ### Recommendations
48
 
49
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
50
 
51
  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.
52
 
53
+ ---
54
  ## How to Get Started with the Model
55
 
56
+ <details>
57
+ <summary>Click to expand</summary>
58
+
59
  Use the code below to get started with the model.
60
 
61
  ```python
62
  from transformers import AutoModelForCausalLM, AutoTokenizer
63
 
64
+ tokenizer = AutoTokenizer.from_pretrained("sambanovasystems/BLOOMChat-176B-v1")
65
+ model = AutoModelForCausalLM.from_pretrained("sambanovasystems/BLOOMChat-176B-v1", device_map="auto", torch_dtype="auto")
66
  ```
67
 
68
 
 
95
  <bot>:
96
  ```
97
 
98
+ </details>
99
+
100
+ ---
101
+
102
+ ## Some example completions
103
+
104
+ <details>
105
+ <summary>Click to expand</summary>
106
+
107
  ```
108
  <human>: What does it mean for the Fed to raise or lower interest rates?
109
  <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.
 
156
  Protons are found in the nucleus of atoms, while neutrons are found in the nucleus of atoms.
157
  In the nucleus of atoms, protons and neutrons are bound together in a structure called a nucleus, which gives the atom its stability.
158
  ```
159
+
160
+ </details>
161
+
162
+ ---
163
+
164
+ ## Evaluation Graphs
165
+
166
+ <details>
167
+ <summary>Click to expand</summary>
168
 
169
  <!-- This section describes the evaluation protocols and provides the results. -->
170
 
 
180
  </figure>
181
  <br>
182
 
183
+ </details>
184
+
185
+ ---
186
+
187
  ## Training Details
188
 
189
+ <details>
190
+ <summary>Click to expand</summary>
191
+
192
  ### Training Data
193
 
194
  <!-- 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. -->
 
248
  - End Learning Ratio: 0.1
249
  - Weight decay: 0.1
250
 
251
+ </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.