Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions Collaboration.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,21 @@ Follow our [LinkedIn page](https://www.linkedin.com/company/instructlab) for upd

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

### [Mastodon](#mastodon)

Join the [InstructLab Mastodon server](https://mastodon.social/@InstructLab)
to find out what's going on in the InstructLab world.

### [Bluesky](#bluesky)

Follow us on [Bluesky](https://bsky.app/profile/instructlab.bsky.social).
This channel is currently inactive, but stay tuned for our next updates.

### [Reddit](#reddit)

Check out the [InstructLab subreddit](https://reddit.com/r/instructlab)- feel free to share
your experience with using and contributing to InstructLab. Every article is welcomed!

### [YouTube](#youtube)

Subscribe to the [InstructLab YouTube channel](https://www.youtube.com/@InstructLab) for regular updates when we post
Expand Down
14 changes: 1 addition & 13 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,19 +336,7 @@ TODO: Update with mailing list details once these are created. Related issue

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

The local training is the most hardware intensive part of this process. Your hardware determines how fast/slow training
the model locally will take.

To run and train InstructLab locally, you must meet the following requirements:

- A supported operating system
- A Linux-based operating system
- An Apple Silicon M1, M2, or M3 system
- A Windows system with WSL (Windows Subsystem for Linux)
- Python 3.10 or 3.11, including the development headers
- Approximately 10GB of free disk space to get through the `ilab generate` step
- Approximately 60GB of free disk space is needed to run the entire process locally on Apple hardware
- About 32 GB RAM
Check out the [HARDWARE REQUIREMENTS](HW_REQS.md)

## Glossary

Expand Down
24 changes: 24 additions & 0 deletions HW_REQS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## 📋 Hardware requirements

The local training is the most hardware intensive part of this process.
Your hardware determines how fast/slow training the model locally will take.
To run and train InstructLab locally, you must meet the following requirements:

The local training is the most hardware intensive part of this process. Your hardware determines how fast/slow training
the model locally will take.

To run and train InstructLab locally, you must meet the following requirements:

1. A supported operating system
- A Linux-based operating system
- An Apple Silicon M1, M2, or M3 system
- A Windows system with WSL (Windows Subsystem for Linux)
2. Python 3.10 or 3.11, including the development headers
3. Approximately 10GB of free disk space to get through the `ilab generate` step
4. Approximately 60GB of free disk space is needed to run the entire process locally on Apple hardware
5. About 32 GB RAM

> **NOTE:** Python 3.12 is currently not supported, because some dependencies don't work on Python 3.12, yet.
<!-- -->
> **NOTE:** When installing the `ilab` CLI on macOS, you may have to run the
> `xcode-select --install` command, installing the required packages previously listed.
6 changes: 1 addition & 5 deletions QUICK_START_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,7 @@ the `cli`, please see [the ilab CLI README](https://github.com/instructlab/instr

## 📋 Requirements

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

## ✅ Getting started

Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ the server.
- [LICENSE](LICENSE)
- [README](README.md)
- [CONTRIBUTING](CONTRIBUTING.md)
- [HARDWARE REQUIREMENTS](HW_REQS.md)
- [MAINTAINERS](MAINTAINERS.md)
- [SECURITY](SECURITY.md)
- [CHANGELOG](CHANGELOG.md)
Loading