[Docs] Refine documentation and README.md #75
+787
−289
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add step to copy Graal JARs into the build directory.
- Consolidate redundant commands for copying Graal JARs. - Remove repeated `which tornado` checks for clearer and cleaner steps. - Add `GRAAL_JARS` environment variable for improved configuration.
- Introduce `code-quality` job for Spotless formatting checks. - Adjust `build-and-run` workflow to depend on `code-quality`. - Refactor environment variables and streamline commands. - Replace redundant directory paths with variables for clarity.
- Introduce `fail-fast: false` and matrix strategy for `opencl` and `ptx` backends. - Modify build and execution steps to dynamically use the selected backend.
- Introduced `gpullama3-architecture.svg` and `gpullama3-architecture-light.svg` diagrams. - Improved README with a simplified model collection reference. - Moved detailed GPU requirements and CLI options to `RUN_DEBUG.md` for clarity.
Removed Maven requirement from installation instructions.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refines the project documentation by introducing visual architecture diagrams and reorganizing content for better clarity. The README is streamlined while detailed technical information is moved to a dedicated debugging guide.
- Adds two architecture diagrams (dark and light theme SVG files) showing the GPULlama3.java stack
- Simplifies the README by replacing extensive model download links with a reference to a Hugging Face collection
- Creates RUN_DEBUG.md containing GPU memory requirements and comprehensive CLI options previously in README
Reviewed changes
Copilot reviewed 2 out of 5 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/diagrams/gpullama3-architecture.svg | New dark-themed architecture diagram showing the complete GPULlama3.java stack from Java applications through hardware |
| docs/diagrams/gpullama3-architecture-light.svg | Light-themed variant of the architecture diagram |
| docs/RUN_DEBUG.md | New file consolidating GPU requirements, CLI options documentation, and debug/profiling examples |
| README.md | Simplified model downloads section and moved technical details to RUN_DEBUG.md; added link to new debugging guide |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - ✅ Intel GPUs (OpenCL) | ||
| - ✅ Apple GPUs (OpenCL) | ||
| Click [here](https://github.com/beehive-lab/GPULlama3.java/tree/main/docs/RUN_DEBUB.md) for more run and debugging tips, also how to use the ./llama-tornado cli to run the model with different flags. | ||
|
|
There was a problem hiding this comment.
Corrected spelling of 'RUN_DEBUB' to 'RUN_DEBUG' in the file path.
Suggested change
| Click [here](https://github.com/beehive-lab/GPULlama3.java/tree/main/docs/RUN_DEBUG.md) for more run and debugging tips, also how to use the ./llama-tornado cli to run the model with different flags. |
…organization - Removed detailed GPU memory troubleshooting from `README.md` to avoid redundancy. - Added and expanded GPU troubleshooting section in `RUN_DEBUG.md` for clearer guidance.
mikepapadim
force-pushed
the
feat/cleanup-readme
branch
from
7925766 to
22d04f3
Compare
Member
Author
|
/rerun |
|
🚀 Workflow rerun started Mode: |
|
✅ Workflow rerun success |
Member
Author
|
/rerun all |
|
🚀 Workflow rerun started Mode: |
|
✅ Workflow rerun success |
Member
Author
|
/rerun help |
🔄 Rerun Workflow Commands
Note: Only completed workflows can be rerun. In-progress workflows are skipped. |
Member
Author
|
/rerun all |
|
🚀 Workflow rerun started Mode: |
|
✅ Workflow rerun success |
Member
Author
|
/rerun help |
🔄 Rerun Workflow Commands
Note: Only completed workflows can be rerun. In-progress workflows are skipped. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
gpullama3-architecture.svgandgpullama3-architecture-light.svgdiagrams.RUN_DEBUG.mdfor clarity.