Skip to content

docs: add s390x build documentation #14264

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.

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

Merged
merged 15 commits into from
Jun 18, 2025
Merged

Conversation

taronaeo
Copy link
Contributor

This PR includes the s390x specific build documentation. I've decided to separate it from the default build.md because we're a big-endian architecture that need more documentation to get up and running.

Feel free to let me know if there are other ways to approach this documentation.

Please review this pull request and consider merging into the main repository. Thank you!

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 18, 2025
@slaren slaren requested a review from Copilot June 18, 2025 16:41
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds dedicated build documentation for the s390x (IBM Z & LinuxONE) architecture, including CPU build instructions, model conversion steps, and performance tuning tips.

  • Introduces docs/build-s390x.md with s390x-specific build and conversion guidance
  • Covers BLAS-enabled builds, GGUF model endian conversions, and IBM accelerator notes
  • Details architectural performance tuning and support channels
Comments suppressed due to low confidence (4)

docs/build-s390x.md:2

  • The link to build.md may not resolve correctly; prefix it with a relative path (e.g., ./build.md) or use the full repository path to ensure it works from within docs/.
> This build documentation is specific only to IBM Z & LinuxONE mainframes (s390x). You can find the build documentation for other architectures: [build.md](build.md).

docs/build-s390x.md:73

  • The hyperlink hf.co/collections/... is missing the https:// prefix and will render as a relative link; update it to https://hf.co/collections/....
    You can find popular models pre-converted and verified at [s390x Ready Models](hf.co/collections/taronaeo/s390x-ready-models-672765393af438d0ccb72a08).

docs/build-s390x.md:120

  • [nitpick] The phrase “No direction at the moment” is vague; consider rephrasing to something like “No support currently available” for clarity.
*Only available in IBM z16 or later system. No direction at the moment.*

docs/build-s390x.md:124

  • [nitpick] The wording here is unclear; consider changing to “Not supported at this time” or similar to make it explicit.
*No direction at the moment.*

@ericcurtin ericcurtin merged commit 8d94713 into ggml-org:master Jun 18, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants