diff --git a/gpt4all-bindings/csharp/README.md b/gpt4all-bindings/csharp/README.md index 6d1171bf..458e09a7 100644 --- a/gpt4all-bindings/csharp/README.md +++ b/gpt4all-bindings/csharp/README.md @@ -23,6 +23,12 @@ gpt4all-bindings/ └── linux-x64 ``` +## Prerequisites + +On Windows and Linux, building GPT4All requires the complete Vulkan SDK. You may download it from here: https://vulkan.lunarg.com/sdk/home + +macOS users do not need Vulkan, as GPT4All will use Metal instead. + ## Local Build Instructions > **Note** > Tested On: diff --git a/gpt4all-bindings/python/README.md b/gpt4all-bindings/python/README.md index 9de65faf..0e7aeae0 100644 --- a/gpt4all-bindings/python/README.md +++ b/gpt4all-bindings/python/README.md @@ -15,6 +15,14 @@ pip install gpt4all ## Local Build Instructions +### Prerequisites + +On Windows and Linux, building GPT4All requires the complete Vulkan SDK. You may download it from here: https://vulkan.lunarg.com/sdk/home + +macOS users do not need Vulkan, as GPT4All will use Metal instead. + +### Building the python bindings + **NOTE**: If you are doing this on a Windows machine, you must build the GPT4All backend using [MinGW64](https://www.mingw-w64.org/) compiler. 1. Setup `llmodel` diff --git a/gpt4all-bindings/python/docs/gpt4all_typescript.md b/gpt4all-bindings/python/docs/gpt4all_typescript.md index 0277c6a1..61007d69 100644 --- a/gpt4all-bindings/python/docs/gpt4all_typescript.md +++ b/gpt4all-bindings/python/docs/gpt4all_typescript.md @@ -58,6 +58,8 @@ const fltArray = createEmbedding(model, "Pain is inevitable, suffering optional" * (win) msvc version 143 * Can be obtained with visual studio 2022 build tools * python 3 +* On Windows and Linux, building GPT4All requires the complete Vulkan SDK. You may download it from here: https://vulkan.lunarg.com/sdk/home +* macOS users do not need Vulkan, as GPT4All will use Metal instead. ### Build (from source) diff --git a/gpt4all-bindings/typescript/README.md b/gpt4all-bindings/typescript/README.md index d34032d7..dd82d2f3 100644 --- a/gpt4all-bindings/typescript/README.md +++ b/gpt4all-bindings/typescript/README.md @@ -58,6 +58,8 @@ const fltArray = createEmbedding(model, "Pain is inevitable, suffering optional" * (win) msvc version 143 * Can be obtained with visual studio 2022 build tools * python 3 +* On Windows and Linux, building GPT4All requires the complete Vulkan SDK. You may download it from here: https://vulkan.lunarg.com/sdk/home +* macOS users do not need Vulkan, as GPT4All will use Metal instead. ### Build (from source) diff --git a/gpt4all-chat/build_and_run.md b/gpt4all-chat/build_and_run.md index 49901e27..6c824b52 100644 --- a/gpt4all-chat/build_and_run.md +++ b/gpt4all-chat/build_and_run.md @@ -6,7 +6,7 @@ gpt4all-chat from source. ## Prerequisites -On Windows and Linux, GPT4All requires Vulkan. You may download it from here: https://vulkan.lunarg.com/sdk/home +On Windows and Linux, building GPT4All requires the complete Vulkan SDK. You may download it from here: https://vulkan.lunarg.com/sdk/home macOS users do not need Vulkan, as GPT4All will use Metal instead.