From 839921dd7332c1378f5284ba15a15e74da854811 Mon Sep 17 00:00:00 2001 From: Marta Tomzik <marta.tomzik@ibm.com> Date: Wed, 23 Oct 2024 23:22:02 +0200 Subject: [PATCH 1/4] [329] extracted hw requirements to separate files and created links Signed-off-by: Marta Tomzik <marta.tomzik@ibm.com> --- FAQ.md | 14 +------------- HW_REQS.md | 16 ++++++++++++++++ QUICK_START_GUIDE.md | 6 +----- README.md | 1 + 4 files changed, 19 insertions(+), 18 deletions(-) create mode 100644 HW_REQS.md diff --git a/FAQ.md b/FAQ.md index 1b7a52a..da62750 100644 --- a/FAQ.md +++ b/FAQ.md @@ -335,19 +335,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.9 or later, 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 diff --git a/HW_REQS.md b/HW_REQS.md new file mode 100644 index 0000000..bd4cabb --- /dev/null +++ b/HW_REQS.md @@ -0,0 +1,16 @@ +## 📋 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: + +1. We anticipate support for more operating systems in the future. For now the supported systems are: + - A Linux-based operating system (tested on Fedora) + - An Apple Silicon M1, M2, or M3 system + - A Windows system with WSL (Windows Subsystem for Linux) . +2. C++ compiler +3. Python 3.10 or Python 3.11 +4. Approximately 60GB disk space (entire process) + +> **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. \ No newline at end of file diff --git a/QUICK_START_GUIDE.md b/QUICK_START_GUIDE.md index 1719f03..a8d8839 100644 --- a/QUICK_START_GUIDE.md +++ b/QUICK_START_GUIDE.md @@ -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.9+ -- Approximately 60GB disk space (entire process) +Check out the [HARDWARE REQUIREMENTS](HW_REQS.md) ## ✅ Getting started diff --git a/README.md b/README.md index f992c23..e5f4e58 100644 --- a/README.md +++ b/README.md @@ -191,6 +191,7 @@ If you would like to see the detailed LICENSE click, see [LICENSE](LICENSE). - [LICENSE](LICENSE) - [README](README.md) - [CONTRIBUTING](CONTRIBUTING.md) +- [HARDWARE REQUIREMENTS](HW_REQS.md) - [MAINTAINERS](MAINTAINERS.md) - [SECURITY](SECURITY.md) - [CHANGELOG](CHANGELOG.md) From 1b5d80022a1d839b87e5ec2fb5e36819bee97ca0 Mon Sep 17 00:00:00 2001 From: Marta Tomzik <marta.tomzik@ibm.com> Date: Wed, 23 Oct 2024 23:34:27 +0200 Subject: [PATCH 2/4] [296] added community pages Signed-off-by: Marta Tomzik <marta.tomzik@ibm.com> --- Collaboration.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/Collaboration.md b/Collaboration.md index e255629..8159aae 100644 --- a/Collaboration.md +++ b/Collaboration.md @@ -138,11 +138,25 @@ 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 video tutorials or playlists of talks about InstructLab from conferences and meetups. + ## [Submitting content](#submitting-content) Have you made a video tutorial, how to document, or other content that would be helpful to folks involved in the From bb73676d1e3cacdd4b6686960107afdf87f3eb3c Mon Sep 17 00:00:00 2001 From: Marta Tomzik <marta.tomzik@ibm.com> Date: Thu, 27 Feb 2025 13:09:53 +0100 Subject: [PATCH 3/4] [296] fixed line breaks Signed-off-by: Marta Tomzik <marta.tomzik@ibm.com> --- Collaboration.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Collaboration.md b/Collaboration.md index 8159aae..dc9efe6 100644 --- a/Collaboration.md +++ b/Collaboration.md @@ -148,15 +148,14 @@ Follow us on [Bluesky](https://bsky.app/profile/instructlab.bsky.social). This c ### [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! - +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 video tutorials or playlists of talks about InstructLab from conferences and meetups. - ## [Submitting content](#submitting-content) Have you made a video tutorial, how to document, or other content that would be helpful to folks involved in the From f3a6600ab34dbb3685b6d4a1fda9cb092ff63ed1 Mon Sep 17 00:00:00 2001 From: Marta Tomzik <marta.tomzik@ibm.com> Date: Thu, 27 Feb 2025 13:24:37 +0100 Subject: [PATCH 4/4] [296] linter update Signed-off-by: Marta Tomzik <marta.tomzik@ibm.com> --- Collaboration.md | 10 ++++++---- HW_REQS.md | 6 ++++-- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/Collaboration.md b/Collaboration.md index 15dffc5..be0010e 100644 --- a/Collaboration.md +++ b/Collaboration.md @@ -152,16 +152,18 @@ Follow us on [X](https://twitter.com/instructlab) for our latest Tweets. Er, Xes ### [Mastodon](#mastodon) -Join the [InstructLab Mastodon server](https://mastodon.social/@InstructLab) to find out what's going on in the InstructLab world. +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. +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! +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) diff --git a/HW_REQS.md b/HW_REQS.md index 6c95492..e17262d 100644 --- a/HW_REQS.md +++ b/HW_REQS.md @@ -1,6 +1,7 @@ ## 📋 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. +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 @@ -19,4 +20,5 @@ To run and train InstructLab locally, you must meet the following requirements: > **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. \ No newline at end of file +> **NOTE:** When installing the `ilab` CLI on macOS, you may have to run the +> `xcode-select --install` command, installing the required packages previously listed. \ No newline at end of file