Skip to content

Commit 3720f1a

Browse files
authored
Merge pull request #390 from marta-tomzik/feature/296-add-community-pages
Feature/296 add community pages
2 parents 90621cb + f3a6600 commit 3720f1a

File tree

5 files changed

+42
-18
lines changed

5 files changed

+42
-18
lines changed

Collaboration.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,21 @@ Follow our [LinkedIn page](https://www.linkedin.com/company/instructlab) for upd
150150

151151
Follow us on [X](https://twitter.com/instructlab) for our latest Tweets. Er, Xes. Er, posts of some sort.
152152

153+
### [Mastodon](#mastodon)
154+
155+
Join the [InstructLab Mastodon server](https://mastodon.social/@InstructLab)
156+
to find out what's going on in the InstructLab world.
157+
158+
### [Bluesky](#bluesky)
159+
160+
Follow us on [Bluesky](https://bsky.app/profile/instructlab.bsky.social).
161+
This channel is currently inactive, but stay tuned for our next updates.
162+
163+
### [Reddit](#reddit)
164+
165+
Check out the [InstructLab subreddit](https://reddit.com/r/instructlab)- feel free to share
166+
your experience with using and contributing to InstructLab. Every article is welcomed!
167+
153168
### [YouTube](#youtube)
154169

155170
Subscribe to the [InstructLab YouTube channel](https://www.youtube.com/@InstructLab) for regular updates when we post

FAQ.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -336,19 +336,7 @@ TODO: Update with mailing list details once these are created. Related issue
336336

337337
### What are the software and hardware requirements for using InstructLab?
338338

339-
The local training is the most hardware intensive part of this process. Your hardware determines how fast/slow training
340-
the model locally will take.
341-
342-
To run and train InstructLab locally, you must meet the following requirements:
343-
344-
- A supported operating system
345-
- A Linux-based operating system
346-
- An Apple Silicon M1, M2, or M3 system
347-
- A Windows system with WSL (Windows Subsystem for Linux)
348-
- Python 3.10 or 3.11, including the development headers
349-
- Approximately 10GB of free disk space to get through the `ilab generate` step
350-
- Approximately 60GB of free disk space is needed to run the entire process locally on Apple hardware
351-
- About 32 GB RAM
339+
Check out the [HARDWARE REQUIREMENTS](HW_REQS.md)
352340

353341
## Glossary
354342

HW_REQS.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## 📋 Hardware requirements
2+
3+
The local training is the most hardware intensive part of this process.
4+
Your hardware determines how fast/slow training the model locally will take.
5+
To run and train InstructLab locally, you must meet the following requirements:
6+
7+
The local training is the most hardware intensive part of this process. Your hardware determines how fast/slow training
8+
the model locally will take.
9+
10+
To run and train InstructLab locally, you must meet the following requirements:
11+
12+
1. A supported operating system
13+
- A Linux-based operating system
14+
- An Apple Silicon M1, M2, or M3 system
15+
- A Windows system with WSL (Windows Subsystem for Linux)
16+
2. Python 3.10 or 3.11, including the development headers
17+
3. Approximately 10GB of free disk space to get through the `ilab generate` step
18+
4. Approximately 60GB of free disk space is needed to run the entire process locally on Apple hardware
19+
5. About 32 GB RAM
20+
21+
> **NOTE:** Python 3.12 is currently not supported, because some dependencies don't work on Python 3.12, yet.
22+
<!-- -->
23+
> **NOTE:** When installing the `ilab` CLI on macOS, you may have to run the
24+
> `xcode-select --install` command, installing the required packages previously listed.

QUICK_START_GUIDE.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,7 @@ the `cli`, please see [the ilab CLI README](https://github.com/instructlab/instr
1717

1818
## 📋 Requirements
1919

20-
- **🍎 Apple M1/M2/M3 Mac or 🐧 Linux system** (tested on Fedora). We anticipate support for more operating systems in
21-
the future.
22-
- C++ compiler
23-
- Python 3.10 or 3.11
24-
- Approximately 60GB disk space (entire process)
20+
Check out the [HARDWARE REQUIREMENTS](HW_REQS.md)
2521

2622
## ✅ Getting started
2723

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,7 @@ the server.
198198
- [LICENSE](LICENSE)
199199
- [README](README.md)
200200
- [CONTRIBUTING](CONTRIBUTING.md)
201+
- [HARDWARE REQUIREMENTS](HW_REQS.md)
201202
- [MAINTAINERS](MAINTAINERS.md)
202203
- [SECURITY](SECURITY.md)
203204
- [CHANGELOG](CHANGELOG.md)

0 commit comments

Comments
 (0)