Skip to content

Commit 8a6637f

Browse files
author
Anthony Cueva
authored
Improving UI fot the FAQ page (LAION-AI#1850)
* 1. Changed the markup of the faq's - This way the faq's are collapsible. - This is native Markdown. No libreries used. * 2. Changed the sidebar item for FAQ * 3. Changed styles to match the color palette Co-authored-by: Anthony Cueva <hi.cuevantngmail.com>
1 parent ba86bf6 commit 8a6637f

File tree

4 files changed

+203
-12
lines changed

4 files changed

+203
-12
lines changed

docs/docs/faq/faq.md docs/docs/faq.md

+185-2
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,281 @@
1+
# Frequently Asked Questions
2+
3+
In this page, there are some of the most frequently asked questions.
4+
15
## Questions about the project
26

7+
<details>
8+
<summary>
9+
310
### How far along is this project?
411

12+
</summary>
13+
514
We are in the early stages of development, working from established research in
615
applying RLHF to large language models.
716

17+
</details>
18+
19+
<details>
20+
<summary>
21+
822
### Can I install Open Assistant locally and chat with it?
923

24+
</summary>
25+
1026
The project is not at that stage yet. See
1127
[the plan](https://github.com/LAION-AI/Open-Assistant#the-plan).
1228

29+
</details>
30+
31+
<details>
32+
<summary>
33+
1334
### What is the Docker command for?
1435

36+
</summary>
37+
1538
Only for local development. It does not launch an AI model.
1639

40+
</details>
41+
42+
<details>
43+
<summary>
44+
1745
### Is an AI model ready to test yet?
1846

47+
</summary>
48+
1949
Not yet. The data you help us collect now through
2050
[https://open-assistant.io/](https://open-assistant.io/) will be used to improve
2151
it.
2252

53+
</details>
54+
55+
<details>
56+
<summary>
57+
2358
### What license does Open Assistant use?
2459

60+
</summary>
61+
2562
The code and models are licensed under the Apache 2.0 license.
2663

64+
</details>
65+
66+
<details>
67+
<summary>
68+
2769
### Is the model open?
2870

71+
</summary>
72+
2973
The model will be open. Some very early prototype models are published on
3074
HuggingFace. Follow the discussion in the Discord channel
3175
[#ml-models-demo](https://discord.com/channels/1055935572465700980/1067096888530178048).
3276

77+
</details>
78+
79+
<details>
80+
<summary>
81+
3382
### Which base model will be used?
3483

84+
</summary>
85+
3586
It's still being discussed. Options include Pythia, GPT-J, and a bunch more..
3687
You can follow the discussion in the Discord channel
3788
[#data-discussion](https://discord.com/channels/1055935572465700980/1058348535612985394).
3889

90+
</details>
91+
92+
<details>
93+
<summary>
94+
3995
### Can I download the data?
4096

97+
</summary>
98+
4199
You will be able to, under CC BY 4.0, but it's not released yet. We want to
42100
remove spam and PII before releasing it.
43101

102+
</details>
103+
104+
<details>
105+
<summary>
106+
44107
### Who is behind Open Assistant?
45108

109+
</summary>
110+
46111
Open Assistant is a project organized by [LAION](https://laion.ai/) and
47112
individuals around the world interested in bringing this technology to everyone.
48113

114+
</details>
115+
116+
<details>
117+
<summary>
118+
49119
### Will Open Assistant be free?
50120

121+
</summary>
122+
51123
Yes, Open Assistant will be free to use and modify.
52124

125+
</details>
126+
127+
<details>
128+
<summary>
129+
53130
### What hardware will be required to run the models?
54131

132+
</summary>
55133
There will be versions which will be runnable on consumer hardware.
56134

135+
</details>
136+
137+
<details>
138+
<summary>
139+
57140
### How can I contribute?
58141

142+
</summary>
143+
59144
If you want to help in the data collection for training the model, go to the
60145
website [https://open-assistant.io/](https://open-assistant.io/). If you want to
61146
contribute code, take a look at the
62147
[tasks in GitHub](https://github.com/orgs/LAION-AI/projects/3) and grab one.
63148
Take a look at this
64149
[contributing guide](https://github.com/LAION-AI/Open-Assistant/blob/main/CONTRIBUTING.md).
65150

151+
</details>
152+
66153
## Questions about the model training website
67154

155+
<details>
156+
<summary>
157+
68158
### Can I use ChatGPT to help in training Open Assistant, for instance, by generating answers?
69159

160+
</summary>
161+
70162
No, it is against their terms of service to use it to help train other models.
71163
See
72164
[this issue](https://github.com/LAION-AI/Open-Assistant/issues/471#issuecomment-1374392299).
73165
ChatGPT-like answers will be removed.
74166

167+
</details>
168+
169+
<details>
170+
<summary>
171+
75172
### What should I do if I don't know how to complete the task as an assistant?
76173

174+
</summary>
77175
Skip it.
176+
</details>
177+
178+
<details>
179+
<summary>
78180

79181
### Should I fact check the answers by the assistant?
80182

183+
</summary>
184+
81185
Yes, you should try. If you are not sure, skip the task.
82186

187+
</details>
188+
189+
<details>
190+
<summary>
191+
83192
### How can I see my score?
84193

194+
</summary>
195+
85196
In your [account settings](https://open-assistant.io/account).
86197

198+
</details>
199+
200+
<details>
201+
<summary>
202+
87203
### Can we see how many data points have been collected?
88204

205+
</summary>
206+
89207
There's no public interface for that yet. However, some updates are posted
90208
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>
92215

93216
### How do I write and label prompts?
94217

218+
</summary>
219+
95220
Check the
96221
[guidelines](https://projects.laion.ai/Open-Assistant/docs/guides/guidelines).
97222

223+
</details>
224+
225+
<details>
226+
<summary>
227+
98228
### Where can I report a bug or create a new feature request?
99229

230+
</summary>
231+
100232
In the [GitHub issues](https://github.com/LAION-AI/Open-Assistant/issues).
101233

234+
</details>
235+
236+
<details>
237+
<summary>
238+
102239
### Why am I not allowed to write about this topic, even though it isn't illegal?
103240

241+
</summary>
242+
104243
We want to ensure that the Open Assistant dataset is as accessible as possible.
105244
As such, it's necessary to avoid any harmful or offensive content that could be
106245
grounds for removal on sites such as Hugging Face. Likewise, we want the model
107246
to be trained to reject as few questions as possible, so it's important to not
108247
include prompts that leave the assistant with no other choice but to refuse in
109248
order to avoid the generation of harmful content.
110249

250+
</details>
251+
111252
## Questions about developing
112253

254+
<details>
255+
<summary>
256+
113257
### Docker-Compose instead of Docker Compose
114258

259+
</summary>
260+
115261
If you are using `docker-compose` instead of `docker compose` (note the " "
116262
instead of the "-"), you should update your docker cli to the latest version.
117263
`docker compose` is the most recent version and should be used instead of
118-
`docker-compose`
264+
`docker-compose`.
119265

120266
For more details and information check out
121267
[this SO thread](https://stackoverflow.com/questions/66514436/difference-between-docker-compose-and-docker-compose)
122268
that explains it all in detail.
123269

270+
</details>
271+
272+
<details>
273+
<summary>
274+
124275
### Enable Docker's BuildKit Backend
125276

277+
</summary>
278+
126279
[BuildKit](https://docs.docker.com/build/buildkit/) is Docker's new and improved
127280
builder backend. In addition to being faster and more efficient, it supports
128281
many new features, among which is the ability to provide a persistent cache,
@@ -148,8 +301,15 @@ You could also, more conveniently,
148301
or use
149302
[Docker Buildx](https://docs.docker.com/build/#:~:text=The%20new%20client%20Docker%20Buildx).
150303

304+
</details>
305+
306+
<details>
307+
<summary>
308+
151309
### Pre-commit
152310

311+
</summary>
312+
153313
We are using pre-commit to ensure the quality of the code as well as the same
154314
code standard.
155315

@@ -167,8 +327,15 @@ So from now on, in your next commits it will run the `pre-commit` on the files
167327
that have been staged. If there has been any error, you will need to solve that,
168328
and then stage+commit again the changes.
169329

330+
</details>
331+
332+
<details>
333+
<summary>
334+
170335
### Docker Cannot Start Container: Permission Denied
171336

337+
</summary>
338+
172339
Instead of running docker with the root command always, you could create a
173340
`docker` group with granted permissions (root):
174341

@@ -190,8 +357,15 @@ still are not able, can try to reboot terminal:
190357
reboot
191358
```
192359

360+
</details>
361+
362+
<details>
363+
<summary>
364+
193365
### Docker Cannot Stop Container
194366

367+
</summary>
368+
195369
If you try to shut down the services (`docker-compose down`), and you are
196370
getting permission denied (using root user), you can try the following:
197371

@@ -203,8 +377,15 @@ getting permission denied (using root user), you can try the following:
203377
docker rm -f <container id>
204378
```
205379

380+
</details>
381+
382+
<details>
383+
<summary>
384+
206385
### Docker Port Problems
207386

387+
</summary>
388+
208389
Oftentimes people already have some Postgres instance running on the dev
209390
machine. To avoid port problems, change the ports in the `docker-compose.yml` to
210391
ones excluding `5433`, like:
@@ -216,3 +397,5 @@ ones excluding `5433`, like:
216397
5. Add `- POSTGRES_PORT=5432` to `backend.environment`
217398
6. Change `web.environment.DATABASE_URL` to
218399
`postgres://postgres:postgres@webdb:5432/oasst_web`
400+
401+
</details>

docs/docs/faq/README.md

-3
This file was deleted.

docs/sidebars.js

+2-6
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,9 @@ const sidebars = {
7272
items: ["presentations/list"],
7373
},
7474
{
75-
type: "category",
75+
type: "doc",
7676
label: "FAQ",
77-
link: {
78-
type: "doc",
79-
id: "faq/README",
80-
},
81-
items: ["faq/faq"],
77+
id: "faq",
8278
},
8379
],
8480
};

0 commit comments

Comments
 (0)