diff --git a/README.md b/README.md index d1a5b4d6..afe40c4e 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ Run large language models โ€” now with **Vision**, **Audio**, **Embedding** and ๐Ÿ”ฝ **[Download](https://github.com/FastFlowLM/FastFlowLM/releases/latest/download/flm-setup.exe)** | ๐Ÿ“Š **[Benchmarks](https://fastflowlm.com/docs/benchmarks/)** | ๐Ÿ“ฆ **[Model List](https://fastflowlm.com/docs/models/)** + ๐Ÿง **[Linux Getting Started Guide](docs/linux-getting-started.md)** ๐Ÿ“– **[Docs](https://fastflowlm.com/docs)** | ๐Ÿ“บ **[Demos](https://www.youtube.com/@FastFlowLM-YT/playlists)** | ๐Ÿงช **[Test Drive](https://fastflowlm.com/docs/#-test-drive-remote-demo)** | ๐Ÿ’ฌ **[Discord](https://discord.gg/z24t23HsHF)** diff --git a/docs/linux-getting-started.md b/docs/linux-getting-started.md new file mode 100644 index 00000000..6f950f75 --- /dev/null +++ b/docs/linux-getting-started.md @@ -0,0 +1,94 @@ +# Linux Getting Started Guide + +This guide will help you get started with FastFlowLM on Linux, including setup for various distributions and NPU (Neural Processing Unit) support. + +## Supported Distributions +- Ubuntu 24.04 LTS +- Ubuntu 25.10 +- Arch Linux +- Other (Generic Linux) + +--- + +## 1. Prerequisites +- `amdxdna` driver (included in kernel 7.0+, or via `amdxdna-dkms`) +- NPU firmware version 1.1.0.0 or later +- Python 3.8+ +- XRT stack from AMD + +--- + +## 2. System Preparation + + +### Ubuntu (24.04, 25.10) + +#### 1. Add the AMD XRT PPA (Required for NPU/XDNA) +The AMD XRT stack is a prerequisite for NPU support. Add AMD's PPA: +```sh +sudo add-apt-repository ppa:amd-team/xrt +sudo apt update +``` +See [amd-team/xrt PPA](https://launchpad.net/~amd-team/+archive/ubuntu/xrt) for details. + +#### 2. Install XRT and NPU Drivers +```sh +sudo apt install libxrt-npu2 amdxdna-dkms +``` + +#### 3. Reboot +```sh +sudo reboot +``` + +#### 4. Install FastFlowLM +- Download the latest `.deb` package from the [Releases page](https://github.com/FastFlowLM/FastFlowLM/releases): + +```sh +sudo apt install ./fastflowlm*.deb +``` + +#### 5. (NPU) Check memlock limit +- Run: + ```sh + ulimit -l + ``` +- If not `unlimited`, add to `/etc/security/limits.conf`: + ``` + * soft memlock unlimited + * hard memlock unlimited + ``` +- Reboot system + +--- + +### Building from Source + +1. Clone the repository: + ```sh + git clone https://github.com/FastFlowLM/FastFlowLM.git + cd FastFlowLM + ``` +2. Build: + ```sh + cd src + cmake --preset linux-default + cmake --build --preset linux-default -j$(nproc) + cmake --install --preset linux-default + ``` + +--- + +## 4. Validating NPU Setup + +To validate your NPU setup, run: +```sh +flm validate +``` +You should see output similar to: +``` +[Linux] Kernel: 7.0.0-rc1-00052-g27936bfca73d +[Linux] NPU: /dev/accel/accel0 +[Linux] NPU FW Version: 1.1.2.64 +[Linux] Memlock Limit: infinity +``` \ No newline at end of file