1
+ # Frequently Asked Questions
2
+
3
+ In this page, there are some of the most frequently asked questions.
4
+
1
5
## Questions about the project
2
6
7
+ <details >
8
+ <summary >
9
+
3
10
### How far along is this project?
4
11
12
+ </summary >
13
+
5
14
We are in the early stages of development, working from established research in
6
15
applying RLHF to large language models.
7
16
17
+ </details >
18
+
19
+ <details >
20
+ <summary >
21
+
8
22
### Can I install Open Assistant locally and chat with it?
9
23
24
+ </summary >
25
+
10
26
The project is not at that stage yet. See
11
27
[ the plan] ( https://github.com/LAION-AI/Open-Assistant#the-plan ) .
12
28
29
+ </details >
30
+
31
+ <details >
32
+ <summary >
33
+
13
34
### What is the Docker command for?
14
35
36
+ </summary >
37
+
15
38
Only for local development. It does not launch an AI model.
16
39
40
+ </details >
41
+
42
+ <details >
43
+ <summary >
44
+
17
45
### Is an AI model ready to test yet?
18
46
47
+ </summary >
48
+
19
49
Not yet. The data you help us collect now through
20
50
[ https://open-assistant.io/ ] ( https://open-assistant.io/ ) will be used to improve
21
51
it.
22
52
53
+ </details >
54
+
55
+ <details >
56
+ <summary >
57
+
23
58
### What license does Open Assistant use?
24
59
60
+ </summary >
61
+
25
62
The code and models are licensed under the Apache 2.0 license.
26
63
64
+ </details >
65
+
66
+ <details >
67
+ <summary >
68
+
27
69
### Is the model open?
28
70
71
+ </summary >
72
+
29
73
The model will be open. Some very early prototype models are published on
30
74
HuggingFace. Follow the discussion in the Discord channel
31
75
[ #ml-models-demo] ( https://discord.com/channels/1055935572465700980/1067096888530178048 ) .
32
76
77
+ </details >
78
+
79
+ <details >
80
+ <summary >
81
+
33
82
### Which base model will be used?
34
83
84
+ </summary >
85
+
35
86
It's still being discussed. Options include Pythia, GPT-J, and a bunch more..
36
87
You can follow the discussion in the Discord channel
37
88
[ #data-discussion] ( https://discord.com/channels/1055935572465700980/1058348535612985394 ) .
38
89
90
+ </details >
91
+
92
+ <details >
93
+ <summary >
94
+
39
95
### Can I download the data?
40
96
97
+ </summary >
98
+
41
99
You will be able to, under CC BY 4.0, but it's not released yet. We want to
42
100
remove spam and PII before releasing it.
43
101
102
+ </details >
103
+
104
+ <details >
105
+ <summary >
106
+
44
107
### Who is behind Open Assistant?
45
108
109
+ </summary >
110
+
46
111
Open Assistant is a project organized by [ LAION] ( https://laion.ai/ ) and
47
112
individuals around the world interested in bringing this technology to everyone.
48
113
114
+ </details >
115
+
116
+ <details >
117
+ <summary >
118
+
49
119
### Will Open Assistant be free?
50
120
121
+ </summary >
122
+
51
123
Yes, Open Assistant will be free to use and modify.
52
124
125
+ </details >
126
+
127
+ <details >
128
+ <summary >
129
+
53
130
### What hardware will be required to run the models?
54
131
132
+ </summary >
55
133
There will be versions which will be runnable on consumer hardware.
56
134
135
+ </details >
136
+
137
+ <details >
138
+ <summary >
139
+
57
140
### How can I contribute?
58
141
142
+ </summary >
143
+
59
144
If you want to help in the data collection for training the model, go to the
60
145
website [ https://open-assistant.io/ ] ( https://open-assistant.io/ ) . If you want to
61
146
contribute code, take a look at the
62
147
[ tasks in GitHub] ( https://github.com/orgs/LAION-AI/projects/3 ) and grab one.
63
148
Take a look at this
64
149
[ contributing guide] ( https://github.com/LAION-AI/Open-Assistant/blob/main/CONTRIBUTING.md ) .
65
150
151
+ </details >
152
+
66
153
## Questions about the model training website
67
154
155
+ <details >
156
+ <summary >
157
+
68
158
### Can I use ChatGPT to help in training Open Assistant, for instance, by generating answers?
69
159
160
+ </summary >
161
+
70
162
No, it is against their terms of service to use it to help train other models.
71
163
See
72
164
[ this issue] ( https://github.com/LAION-AI/Open-Assistant/issues/471#issuecomment-1374392299 ) .
73
165
ChatGPT-like answers will be removed.
74
166
167
+ </details >
168
+
169
+ <details >
170
+ <summary >
171
+
75
172
### What should I do if I don't know how to complete the task as an assistant?
76
173
174
+ </summary >
77
175
Skip it.
176
+ </details >
177
+
178
+ <details >
179
+ <summary >
78
180
79
181
### Should I fact check the answers by the assistant?
80
182
183
+ </summary >
184
+
81
185
Yes, you should try. If you are not sure, skip the task.
82
186
187
+ </details >
188
+
189
+ <details >
190
+ <summary >
191
+
83
192
### How can I see my score?
84
193
194
+ </summary >
195
+
85
196
In your [ account settings] ( https://open-assistant.io/account ) .
86
197
198
+ </details >
199
+
200
+ <details >
201
+ <summary >
202
+
87
203
### Can we see how many data points have been collected?
88
204
205
+ </summary >
206
+
89
207
There's no public interface for that yet. However, some updates are posted
90
208
periodically in
91
- [ the #data-updates Discord channel] ( https://discord.com/channels/1055935572465700980/1073706683068596394 ) .
209
+ [ the #data-updates Discord channel] ( https://discord.com/channels/1055935572465700980/1073706683068596394 )
210
+
211
+ </details >
212
+
213
+ <details >
214
+ <summary >
92
215
93
216
### How do I write and label prompts?
94
217
218
+ </summary >
219
+
95
220
Check the
96
221
[ guidelines] ( https://projects.laion.ai/Open-Assistant/docs/guides/guidelines ) .
97
222
223
+ </details >
224
+
225
+ <details >
226
+ <summary >
227
+
98
228
### Where can I report a bug or create a new feature request?
99
229
230
+ </summary >
231
+
100
232
In the [ GitHub issues] ( https://github.com/LAION-AI/Open-Assistant/issues ) .
101
233
234
+ </details >
235
+
236
+ <details >
237
+ <summary >
238
+
102
239
### Why am I not allowed to write about this topic, even though it isn't illegal?
103
240
241
+ </summary >
242
+
104
243
We want to ensure that the Open Assistant dataset is as accessible as possible.
105
244
As such, it's necessary to avoid any harmful or offensive content that could be
106
245
grounds for removal on sites such as Hugging Face. Likewise, we want the model
107
246
to be trained to reject as few questions as possible, so it's important to not
108
247
include prompts that leave the assistant with no other choice but to refuse in
109
248
order to avoid the generation of harmful content.
110
249
250
+ </details >
251
+
111
252
## Questions about developing
112
253
254
+ <details >
255
+ <summary >
256
+
113
257
### Docker-Compose instead of Docker Compose
114
258
259
+ </summary >
260
+
115
261
If you are using ` docker-compose ` instead of ` docker compose ` (note the " "
116
262
instead of the "-"), you should update your docker cli to the latest version.
117
263
` docker compose ` is the most recent version and should be used instead of
118
- ` docker-compose `
264
+ ` docker-compose ` .
119
265
120
266
For more details and information check out
121
267
[ this SO thread] ( https://stackoverflow.com/questions/66514436/difference-between-docker-compose-and-docker-compose )
122
268
that explains it all in detail.
123
269
270
+ </details >
271
+
272
+ <details >
273
+ <summary >
274
+
124
275
### Enable Docker's BuildKit Backend
125
276
277
+ </summary >
278
+
126
279
[ BuildKit] ( https://docs.docker.com/build/buildkit/ ) is Docker's new and improved
127
280
builder backend. In addition to being faster and more efficient, it supports
128
281
many new features, among which is the ability to provide a persistent cache,
@@ -148,8 +301,15 @@ You could also, more conveniently,
148
301
or use
149
302
[ Docker Buildx] ( https://docs.docker.com/build/#:~:text=The%20new%20client%20Docker%20Buildx ) .
150
303
304
+ </details >
305
+
306
+ <details >
307
+ <summary >
308
+
151
309
### Pre-commit
152
310
311
+ </summary >
312
+
153
313
We are using pre-commit to ensure the quality of the code as well as the same
154
314
code standard.
155
315
@@ -167,8 +327,15 @@ So from now on, in your next commits it will run the `pre-commit` on the files
167
327
that have been staged. If there has been any error, you will need to solve that,
168
328
and then stage+commit again the changes.
169
329
330
+ </details >
331
+
332
+ <details >
333
+ <summary >
334
+
170
335
### Docker Cannot Start Container: Permission Denied
171
336
337
+ </summary >
338
+
172
339
Instead of running docker with the root command always, you could create a
173
340
` docker ` group with granted permissions (root):
174
341
@@ -190,8 +357,15 @@ still are not able, can try to reboot terminal:
190
357
reboot
191
358
```
192
359
360
+ </details >
361
+
362
+ <details >
363
+ <summary >
364
+
193
365
### Docker Cannot Stop Container
194
366
367
+ </summary >
368
+
195
369
If you try to shut down the services (` docker-compose down ` ), and you are
196
370
getting permission denied (using root user), you can try the following:
197
371
@@ -203,8 +377,15 @@ getting permission denied (using root user), you can try the following:
203
377
docker rm -f < container id>
204
378
```
205
379
380
+ </details >
381
+
382
+ <details >
383
+ <summary >
384
+
206
385
### Docker Port Problems
207
386
387
+ </summary >
388
+
208
389
Oftentimes people already have some Postgres instance running on the dev
209
390
machine. To avoid port problems, change the ports in the ` docker-compose.yml ` to
210
391
ones excluding ` 5433 ` , like:
@@ -216,3 +397,5 @@ ones excluding `5433`, like:
216
397
5 . Add ` - POSTGRES_PORT=5432 ` to ` backend.environment `
217
398
6 . Change ` web.environment.DATABASE_URL ` to
218
399
` postgres://postgres:postgres@webdb:5432/oasst_web `
400
+
401
+ </details >
0 commit comments