Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/296 add community pages #390

Merged
merged 5 commits into from
Mar 3, 2025
Merged

Feature/296 add community pages #390

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
839921d
[329] extracted hw requirements to separate files and created links
marta-tomzik Oct 23, 2024
1b5d800
[296] added community pages
marta-tomzik Oct 23, 2024
bb73676
[296] fixed line breaks
marta-tomzik Feb 27, 2025
d8b21f0
[296] merged main + update
marta-tomzik Feb 27, 2025
f3a6600
[296] linter update
marta-tomzik Feb 27, 2025
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
14 changes: 14 additions & 0 deletions Collaboration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,19 +138,33 @@

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)

Check failure on line 155 in Collaboration.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length 

Collaboration.md:155:121 MD013/line-length Line length [Expected: 120; Actual: 130] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md013.md
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.


Check failure on line 159 in Collaboration.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Trailing spaces 

Collaboration.md:159:147 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md009.md

Check failure on line 159 in Collaboration.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length 

Collaboration.md:159:121 MD013/line-length Line length [Expected: 120; Actual: 147] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md013.md
## [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
InstructLab community? Thank you!

Check failure on line 163 in Collaboration.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Trailing spaces 

Collaboration.md:163:180 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md009.md

Check failure on line 163 in Collaboration.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length 

Collaboration.md:163:121 MD013/line-length Line length [Expected: 120; Actual: 180] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md013.md

We would love to help you share it. Please

Check failure on line 165 in Collaboration.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Multiple consecutive blank lines 

Collaboration.md:165 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md012.md
[file an issue in the Community Repo](https://github.com/instructlab/community/issues) or send a note to the
[community email](https://groups.google.com/a/instructlab.ai/g/community) list to let us know about what you have
created.

[committee]: https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT_COMMITTEE.md
14 changes: 1 addition & 13 deletions FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
16 changes: 16 additions & 0 deletions HW_REQS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Check failure on line 3 in HW_REQS.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length 

HW_REQS.md:3:121 MD013/line-length Line length [Expected: 120; Actual: 148] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md013.md
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:

Check failure on line 6 in HW_REQS.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Trailing spaces 

HW_REQS.md:6:102 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md009.md
- 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.

Check failure on line 16 in HW_REQS.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length 

HW_REQS.md:16:121 MD013/line-length Line length [Expected: 120; Actual: 162] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md013.md
6 changes: 1 addition & 5 deletions QUICK_START_GUIDE.md
View file
Open in desktop
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.9+
- 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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Loading