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

Adding GPU support to VTL #54

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adding GPU support to VTL #54

wants to merge 1 commit into from

Conversation

ibrandiay
Copy link

@ibrandiay ibrandiay commented Aug 5, 2024

The goal is to add different backends like CUDA, Vulkan and others, in order to enable training of AI models on GPUs. I also plan to add GPU support for ARM (Android and others)... I have initialized this part that I will develop and update from time to time. Thank you.

Summary by CodeRabbit

  • New Features
    • Added comprehensive documentation for multiple backends (Cuda, OpenCL, OpenMP, Vulkan) of the VTL Engine, including installation instructions and usage examples.
    • Introduced a README for the Image module, enhancing user understanding of its functionality.

These updates improve accessibility and usability for developers integrating different backend technologies within their applications.

Copy link

coderabbitai bot commented Aug 5, 2024

Walkthrough

This update introduces comprehensive README files for each backend of the VTL Engine, including Cuda, OpenCL, OpenMP, and Vulkan, as well as a README for the Image module. These documents provide essential installation instructions, usage examples, and functionality overviews, enhancing user understanding and accessibility. The consistent format across backends simplifies switching between them, making it easier for developers to implement GPU acceleration and parallel processing in their applications.

Changes

Files Change Summary
backends/*/README.md New README files added for Cuda, OpenCL, OpenMP, and Vulkan backends, detailing installation and usage.
tools/Image/Readme.md New README file added for the Image module, providing information on its purpose and functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VTL Engine
    participant Backend

    User->>VTL Engine: Initialize tensor
    VTL Engine->>Backend: Select appropriate backend (e.g., cuda())
    Backend-->>VTL Engine: Device management and tensor creation
    VTL Engine-->>User: Return tensor ready for use
Loading

🐇 In the meadow, the code does bloom,
With backends ready to lift the gloom.
Cuda, OpenCL, they dance and play,
Making computations bright as day!
Documentation clear, all users cheer,
A hop of joy, for changes here! 🌼


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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: 5

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ad01618 and cc4fe9a.

Files selected for processing (6)
  • backends/README.md (1 hunks)
  • backends/cuda/README.md (1 hunks)
  • backends/opencl/README.md (1 hunks)
  • backends/openmp/README.md (1 hunks)
  • backends/vulkan/README.md (1 hunks)
  • tools/Image/Readme.md (1 hunks)
Files skipped from review due to trivial changes (5)
  • backends/cuda/README.md
  • backends/opencl/README.md
  • backends/openmp/README.md
  • backends/vulkan/README.md
  • tools/Image/Readme.md
Additional context used
Markdownlint
backends/README.md

4-4: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)


5-5: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)


6-6: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)


7-7: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)


11-11: null
Headings must start at the beginning of the line

(MD023, heading-start-left)


22-22: null
Headings must start at the beginning of the line

(MD023, heading-start-left)


32-32: null
Headings must start at the beginning of the line

(MD023, heading-start-left)


42-42: null
Headings must start at the beginning of the line

(MD023, heading-start-left)


11-11: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


22-22: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


32-32: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


42-42: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


10-10: null
Bare URL used

(MD034, no-bare-urls)


21-21: null
Bare URL used

(MD034, no-bare-urls)

Comment on lines +21 to +22
First install opencl toolkit: https://www.khronos.org/opencl/
### usage:
Copy link

Choose a reason for hiding this comment

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

Fix heading punctuation and format URL.

The heading should not have trailing punctuation, and the URL should be formatted as a proper link.

-  First install opencl toolkit: https://www.khronos.org/opencl/
+  First install the [OpenCL toolkit](https://www.khronos.org/opencl/)

Committable suggestion was skipped due to low confidence.

Tools
Markdownlint

22-22: null
Headings must start at the beginning of the line

(MD023, heading-start-left)


22-22: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


21-21: null
Bare URL used

(MD034, no-bare-urls)

```

## OpenMP
### usage:
Copy link

Choose a reason for hiding this comment

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

Fix heading punctuation.

The heading should not have trailing punctuation.

-  ### usage:
+  ### usage
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### usage:
### usage
Tools
Markdownlint

32-32: null
Headings must start at the beginning of the line

(MD023, heading-start-left)


32-32: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

Comment on lines +4 to +7
- Cuda
- OpenCL
- OpenMP
- Vulkan
Copy link

Choose a reason for hiding this comment

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

Fix unordered list indentation.

The unordered list items are indented incorrectly. The correct indentation should be 2 spaces.

-   - Cuda
-   - OpenCL
-   - OpenMP
-   - Vulkan
+  - Cuda
+  - OpenCL
+  - OpenMP
+  - Vulkan
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Cuda
- OpenCL
- OpenMP
- Vulkan
- Cuda
- OpenCL
- OpenMP
- Vulkan
Tools
Markdownlint

4-4: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)


5-5: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)


6-6: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)


7-7: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)

Comment on lines +10 to +11
First install cuda toolkit: https://developer.nvidia.com/cuda-downloads
### usage:
Copy link

Choose a reason for hiding this comment

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

Fix heading punctuation and format URL.

The heading should not have trailing punctuation, and the URL should be formatted as a proper link.

-  First install cuda toolkit: https://developer.nvidia.com/cuda-downloads
+  First install the [CUDA toolkit](https://developer.nvidia.com/cuda-downloads)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
First install cuda toolkit: https://developer.nvidia.com/cuda-downloads
### usage:
First install the [CUDA toolkit](https://developer.nvidia.com/cuda-downloads)
### usage
Tools
Markdownlint

11-11: null
Headings must start at the beginning of the line

(MD023, heading-start-left)


11-11: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


10-10: null
Bare URL used

(MD034, no-bare-urls)

```

## Vulkan
### usage:
Copy link

Choose a reason for hiding this comment

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

Fix heading punctuation.

The heading should not have trailing punctuation.

-  ### usage:
+  ### usage
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### usage:
### usage
Tools
Markdownlint

42-42: null
Headings must start at the beginning of the line

(MD023, heading-start-left)


42-42: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

@medvednikov
Copy link
Member

That's amazing, good luck with this!

@ulises-jeremias
Copy link
Member

ulises-jeremias commented Aug 18, 2024

hey @ibrandiay ! nice to know you are planning to work on this. There is already some work initiated on this since we have VCL integrated on VTL, for example here https://github.com/vlang/vtl/blob/main/storage/vcl_d_vcl.v we define the store using VCL and here we have the instantiation method

pub fn (t &Tensor[T]) vcl(params storage.VclStorageParams) !&VclTensor[T] {

(VCL is the official OpenCL wrapper for V part of VSL)

I would like to discuss the design of this solution with you before you start the implementation and maybe implement one backend for each PR just to make it easier to test 😊

```vlang
import vtl
vtl_tensor := vtl.from_array([1.0, 2, 3, 4], [2, 2])!
vtl_tensor.opencl()
Copy link
Member

Choose a reason for hiding this comment

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

no need to have an extra backend for opencl. We must use VCL since it is the V official OpenCL wrapper

pub fn (t &Tensor[T]) vcl(params storage.VclStorageParams) !&VclTensor[T] {

we could have an alias function called opencl tho

@ibrandiay
Copy link
Author

@ulises-jeremias Thanks for the info,
I didn't know an OpenCL wrapper already existed. No need to re-implement it then.
For now, I'm working on the CUDA part for Nvidia GPU support.
Once each backend is implemented, I'll submit a pull request.
Thanks again.

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.

3 participants