mirror of
https://github.com/vosen/ZLUDA.git
synced 2025-10-03 14:50:43 +00:00
Start working on docs
This commit is contained in:
parent
a420601128
commit
ad105f6971
6 changed files with 23 additions and 70 deletions
11
.readthedocs.yaml
Normal file
11
.readthedocs.yaml
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
version: 2
|
||||||
|
build:
|
||||||
|
os: ubuntu-lts-latest
|
||||||
|
tools:
|
||||||
|
rust: latest
|
||||||
|
jobs:
|
||||||
|
install:
|
||||||
|
- cargo install mdbook
|
||||||
|
build:
|
||||||
|
html:
|
||||||
|
- mdbook build docs --dest-dir $READTHEDOCS_OUTPUT/html
|
72
README.md
72
README.md
|
@ -1,74 +1,6 @@
|
||||||
[](https://discord.gg/sg6BNzXuc7)
|
[](https://discord.gg/sg6BNzXuc7)
|
||||||
|
|
||||||
# ZLUDA
|
|
||||||
|
|
||||||
ZLUDA is a drop-in replacement for CUDA on non-NVIDIA GPUs. ZLUDA allows running unmodified CUDA applications using non-NVIDIA GPUs with near-native performance.
|
ZLUDA is a drop-in replacement for CUDA on non-NVIDIA GPUs. ZLUDA allows running unmodified CUDA applications using non-NVIDIA GPUs with near-native performance.
|
||||||
|
|
||||||
ZLUDA supports AMD Radeon RX 5000 series and newer GPUs (both desktop and integrated).
|
<center><font size=100px><b>DOCS</b></font></center>
|
||||||
|
<center><font size=100px><b>NEWS</b></font></center>
|
||||||

|
|
||||||
|
|
||||||
ZLUDA is a work in progress. Follow development here and say hi on [Discord](https://discord.gg/sg6BNzXuc7). For more details, see the announcement: https://vosen.github.io/ZLUDA/blog/zludas-third-life/
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
**Warning**: This version ZLUDA is under heavy development (more [here](https://vosen.github.io/ZLUDA/blog/zludas-third-life/)) and right now only supports Geekbench. ZLUDA probably will not work with your application just yet.
|
|
||||||
|
|
||||||
### Windows
|
|
||||||
You should have a recent AMD GPU driver ("AMD Software: Adrenalin Edition") installed.\
|
|
||||||
To run your application, you should either:
|
|
||||||
* (Recommended approach) Copy ZLUDA-provided `nvcuda.dll` and `nvml.dll` from `target\release` (if built from sources) or `zluda` (if downloaded a zip package) into a path which your application uses to load CUDA. Paths vary application to application, but usually it's the directory where the .exe file is located
|
|
||||||
* Use ZLUDA launcher like below. ZLUDA launcher is known to be buggy and incomplete:
|
|
||||||
```
|
|
||||||
<ZLUDA_DIRECTORY>\zluda_with.exe -- <APPLICATION> <APPLICATIONS_ARGUMENTS>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
Run your application like this:
|
|
||||||
```
|
|
||||||
LD_LIBRARY_PATH=<ZLUDA_DIRECTORY> <APPLICATION> <APPLICATIONS_ARGUMENTS>
|
|
||||||
```
|
|
||||||
|
|
||||||
where `<ZLUDA_DIRECTORY>` is the directory which contains ZLUDA-provided `libcuda.so`: `target/release` if you built from sources or `zluda` if you downloaded a prebuilt package.
|
|
||||||
|
|
||||||
### MacOS
|
|
||||||
|
|
||||||
Not supported
|
|
||||||
|
|
||||||
## Building
|
|
||||||
|
|
||||||
### Dependencies
|
|
||||||
|
|
||||||
* Git
|
|
||||||
* CMake
|
|
||||||
* Python 3
|
|
||||||
* Rust compiler (recent version)
|
|
||||||
* C++ compiler
|
|
||||||
* (Optional, but recommended) [Ninja build system](https://ninja-build.org/)
|
|
||||||
|
|
||||||
### Build steps
|
|
||||||
|
|
||||||
* Git clone the repo (make sure to use `--recursive` option to fetch submodules):
|
|
||||||
`git clone --recursive https://github.com/vosen/ZLUDA.git`
|
|
||||||
* Enter freshly cloned `ZLUDA` directory and build with cargo (this takes a while):
|
|
||||||
`cargo xtask --release`
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
ZLUDA project has a commercial backing and _does not_ accept donations.
|
|
||||||
ZLUDA project accepts pull requests and other non-monetary contributions.
|
|
||||||
|
|
||||||
If you want to contribute a code fix or documentation update, feel free to open a Pull Request.
|
|
||||||
|
|
||||||
### Getting started
|
|
||||||
|
|
||||||
There's no architecture document (yet). The two most important crates in ZLUDA are `ptx` (PTX compiler) and `zluda` (AMD GPU runtime). A good starting point to tinkering with the project is to run one of the `ptx` unit tests under a debugger and understand what it is doing. `cargo test -p ptx -- ::add_amdgpu` is a simple test that adds two numbers.
|
|
||||||
|
|
||||||
Github issues tagged with ["help wanted"](https://github.com/vosen/ZLUDA/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) are tasks that are self-contained. Their level of difficulty varies, and they are not always good beginner tasks, but they are defined unambiguously.
|
|
||||||
|
|
||||||
If you have questions, feel free to ask on [#devtalk channel on Discord](https://discord.com/channels/1273316903783497778/1303329281409159270).
|
|
||||||
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
This software is dual-licensed under either the Apache 2.0 license or the MIT license. See [LICENSE-APACHE](LICENSE-APACHE) or [LICENSE-MIT](LICENSE-MIT) for details
|
|
||||||
|
|
1
docs/.gitignore
vendored
Normal file
1
docs/.gitignore
vendored
Normal file
|
@ -0,0 +1 @@
|
||||||
|
book
|
5
docs/book.toml
Normal file
5
docs/book.toml
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
[book]
|
||||||
|
authors = ["Andrzej Janik"]
|
||||||
|
language = "en"
|
||||||
|
src = "src"
|
||||||
|
title = "ZLUDA"
|
3
docs/src/SUMMARY.md
Normal file
3
docs/src/SUMMARY.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Summary
|
||||||
|
|
||||||
|
- [Chapter 1](./chapter_1.md)
|
1
docs/src/chapter_1.md
Normal file
1
docs/src/chapter_1.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# Chapter 1
|
Loading…
Add table
Add a link
Reference in a new issue