Skip to content

Commit 02405e7

Browse files
committed
[329] extracted hw requirements to separate files and created links
1 parent 6c8779f commit 02405e7

File tree

4 files changed

+19
-18
lines changed

4 files changed

+19
-18
lines changed

FAQ.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -335,19 +335,7 @@ TODO: Update with mailing list details once these are created. Related issue
335335

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

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

352340
## Glossary
353341

HW_REQS.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## 📋 Hardware requirements
2+
3+
The local training is the most hardware intensive part of this process. Your hardware determines how fast/slow training the model locally will take.
4+
To run and train InstructLab locally, you must meet the following requirements:
5+
6+
1. We anticipate support for more operating systems in the future. For now the supported systems are:
7+
- A Linux-based operating system (tested on Fedora)
8+
- An Apple Silicon M1, M2, or M3 system
9+
- A Windows system with WSL (Windows Subsystem for Linux) .
10+
2. C++ compiler
11+
3. Python 3.10 or Python 3.11
12+
4. Approximately 60GB disk space (entire process)
13+
14+
> **NOTE:** Python 3.12 is currently not supported, because some dependencies don't work on Python 3.12, yet.
15+
<!-- -->
16+
> **NOTE:** When installing the `ilab` CLI on macOS, you may have to run the `xcode-select --install` command, installing the required packages previously listed.

QUICK_START_GUIDE.md

+1-5
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.9+
24-
- Approximately 60GB disk space (entire process)
20+
Check out the [HARDWARE REQUIREMENTS](HW_REQS.md)
2521

2622
## ✅ Getting started
2723

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@ If you would like to see the detailed LICENSE click, see [LICENSE](LICENSE).
191191
- [LICENSE](LICENSE)
192192
- [README](README.md)
193193
- [CONTRIBUTING](CONTRIBUTING.md)
194+
- [HARDWARE REQUIREMENTS](HW_REQS.md)
194195
- [MAINTAINERS](MAINTAINERS.md)
195196
- [SECURITY](SECURITY.md)
196197
- [CHANGELOG](CHANGELOG.md)

0 commit comments

Comments
 (0)