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.

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

clean: remove opencl #366

Merged
merged 1 commit into from
Nov 11, 2024
Merged

clean: remove opencl #366

merged 1 commit into from
Nov 11, 2024

Conversation

thewh1teagle
Copy link
Owner

@thewh1teagle thewh1teagle commented Nov 11, 2024

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced Vulkan support for Tauri applications on Ubuntu 22.04.
    • Added instructions for building with Vulkan support on Windows.
  • Bug Fixes

    • Removed deprecated references to clblast across various configurations and scripts, streamlining the build process.
  • Documentation

    • Updated BUILDING.md to reflect changes in build requirements and instructions regarding Vulkan and clblast.
  • Chores

    • Enhanced .gitignore to exclude additional file types and directories, improving repository cleanliness.

Copy link

coderabbitai bot commented Nov 11, 2024

Walkthrough

The changes in this pull request primarily focus on updating workflow configurations for building and testing applications with Vulkan support while removing references to the clblast library. A new job for publishing Tauri applications targeting Vulkan on Ubuntu 22.04 has been added, and testing workflows have been enhanced to support multiple platforms. The .gitignore file has been expanded to include additional patterns and directories. Documentation has been updated to reflect these changes, particularly for building with Vulkan on Windows.

Changes

File Change Summary
.github/workflows/linux_special.yml Added job publish-tauri for Vulkan on Ubuntu 22.04, removed CUDA and ROCm configurations, and included steps for preparing Vulkan SDK and building applications.
.github/workflows/test_core.yml Updated to include a matrix strategy for testing on macOS, Ubuntu 24.04, and Windows, with platform-specific configurations and conditional installations.
.gitignore Added patterns and directories to ignore, including audio, video, and build artifacts, with exceptions for specific files.
.vscode/launch.json Removed CLBlast_DIR from environment variables and adjusted PATH and RUSTFLAGS for debugging configuration.
core/build.rs Removed references to CLBlast_DIR and associated logic, simplifying library management in the build process.
desktop/src-tauri/tauri.windows.conf.json Added vulkan_runtime\x64\*.dll to bundle.resources for Windows builds.
docs/BUILDING.md Added Vulkan build instructions for Windows and removed clblast references from various sections.
scripts/pre_build.js Removed all configurations and references related to clblast, simplifying dependency management for Windows builds.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CI as CI/CD Pipeline
    participant Repo as Repository
    participant Vulkan as Vulkan SDK
    participant Tauri as Tauri Build

    User->>CI: Trigger Build
    CI->>Repo: Checkout Code
    CI->>Vulkan: Prepare Vulkan SDK
    CI->>Tauri: Build Application
    Tauri->>CI: Return Build Artifacts
    CI->>User: Notify Build Completion
Loading

🐰 "In the land of code, where changes bloom,
A new job for Vulkan dispels the gloom.
With clblast now gone, we simplify the way,
Building and testing, come what may!
Hop along, dear friends, let’s celebrate,
A streamlined process, oh, isn’t it great?" 🐇


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
.vscode/launch.json (1)

63-64: LGTM! The removal of CLBlast configurations aligns with the PR objectives.

The changes correctly remove CLBlast-related paths while maintaining the necessary OpenBLAS and FFmpeg configurations.

Consider adding platform-specific launch configurations for better cross-platform support. Here's a suggested approach:

{
    "configurations": [
        {
            "name": "Debug executable 'vibe' in Release mode (Windows)",
            "windows": {
                "env": {
                    "PATH": "${env:PATH};${workspaceFolder}\\desktop\\src-tauri\\openblas\\bin;${workspaceFolder}\\desktop\\src-tauri\\ffmpeg\\bin\\x64",
                    "RUSTFLAGS": "-L ${workspaceFolder}\\desktop\\src-tauri\\openblas\\lib"
                }
            }
        },
        {
            "name": "Debug executable 'vibe' in Release mode (Linux/macOS)",
            "linux": {
                "env": {
                    "PATH": "${env:PATH}:${workspaceFolder}/desktop/src-tauri/openblas/bin:${workspaceFolder}/desktop/src-tauri/ffmpeg/bin/x64",
                    "RUSTFLAGS": "-L ${workspaceFolder}/desktop/src-tauri/openblas/lib"
                }
            },
            "osx": {
                "env": {
                    "PATH": "${env:PATH}:${workspaceFolder}/desktop/src-tauri/openblas/bin:${workspaceFolder}/desktop/src-tauri/ffmpeg/bin/x64",
                    "RUSTFLAGS": "-L ${workspaceFolder}/desktop/src-tauri/openblas/lib"
                }
            }
        }
    ]
}
docs/BUILDING.md (1)

35-41: Improve documentation formatting and clarity for Vulkan setup on Windows.

  1. Use proper heading format instead of emphasis
  2. Add explanation for why admin privileges are required
  3. Use forward slashes in the command for better cross-platform compatibility

Apply these changes:

-_Vulkan (Windows)_
+### Vulkan (Windows)
 
-**Run as admin once!!!**
+> **Important**: Administrative privileges are required for the first run to set up Vulkan SDK components properly.
 
 ```console
-bun run scripts\pre_build.js --vulkan
+bun run scripts/pre_build.js --vulkan

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 Markdownlint</summary>

35-35: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

</details>

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 9edf658983446c7bd09c575c3b8c658f95fde777 and bfc9b9632727c185f156744764dc9aabb7d2912b.

</details>

<details>
<summary>📒 Files selected for processing (8)</summary>

* `.github/workflows/linux_special.yml` (0 hunks)
* `.github/workflows/test_core.yml` (0 hunks)
* `.gitignore` (0 hunks)
* `.vscode/launch.json` (1 hunks)
* `core/build.rs` (0 hunks)
* `desktop/src-tauri/tauri.windows.conf.json` (1 hunks)
* `docs/BUILDING.md` (1 hunks)
* `scripts/pre_build.js` (0 hunks)

</details>

<details>
<summary>💤 Files with no reviewable changes (5)</summary>

* .github/workflows/linux_special.yml
* .github/workflows/test_core.yml
* .gitignore
* core/build.rs
* scripts/pre_build.js

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🪛 Markdownlint</summary>

<details>
<summary>docs/BUILDING.md</summary>

35-35: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

</details>

</details>

</details>

<details>
<summary>🔇 Additional comments (3)</summary>

<details>
<summary>desktop/src-tauri/tauri.windows.conf.json (2)</summary>

`9-10`: **LGTM! Configuration changes align with Vulkan transition.**

The addition of Vulkan runtime DLLs to the resources bundle is consistent with the PR's objective of removing OpenCL and transitioning to Vulkan support.

---

`10-10`: **Verify Vulkan runtime path and required DLLs.**

Please ensure that the path `vulkan_runtime\x64\` exists in your project structure and contains all necessary Vulkan runtime DLLs for Windows builds.

</details>
<details>
<summary>docs/BUILDING.md (1)</summary>

Line range hint `1-999`: **LGTM! Changes align with PR objectives.**

The removal of OpenCL/clblast related content is complete and consistent throughout the documentation. The addition of Vulkan-specific instructions maintains the document's completeness for different build configurations.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 Markdownlint</summary>

35-35: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

</details>

</details>

</details>

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

@thewh1teagle thewh1teagle merged commit 22dd15a into main Nov 11, 2024
7 checks passed
@thewh1teagle thewh1teagle deleted the clean/remove-opencl branch November 12, 2024 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant