Update readme (#962)

tracel-ai · Nov 17, 2023 · 8f1526b · 8f1526b
1 parent ec9df53
commit 8f1526b
Show file tree

Hide file tree

Showing 13 changed files with 485 additions and 97 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
diff --git a/README.md b/README.md
diff --git a/_typos.toml b/_typos.toml
@@ -1,5 +1,5 @@
 [default]
-extend-ignore-identifiers-re = ["ratatui", "NdArray*", "ND"]
+extend-ignore-identifiers-re = ["ratatui", "Ratatui", "NdArray*", "ND"]
 
 [files]
 extend-exclude = [

diff --git a/assets/backend-chip.png b/assets/backend-chip.png
diff --git a/assets/burn-train-tui.png b/assets/burn-train-tui.png
diff --git a/assets/ember-blazingly-fast.png b/assets/ember-blazingly-fast.png
diff --git a/assets/ember-community.png b/assets/ember-community.png
diff --git a/assets/ember-walking.png b/assets/ember-walking.png
diff --git a/assets/ember-wall.png b/assets/ember-wall.png
diff --git a/assets/logo-burn-neutral.webp b/assets/logo-burn-neutral.webp
diff --git a/burn-ndarray/README.md b/burn-ndarray/README.md
@@ -19,3 +19,12 @@ The following flags support various BLAS options:
 
 Note, under the `no_std` mode, a random seed is generated during the build time if the seed is not
 initialized by by `Backend::seed` method.
+
+### Platform Support
+
+| Option     | CPU | GPU | Linux | MacOS | Windows | Android | iOS | WASM |
+| :--------- | :-: | :-: | :---: | :---: | :-----: | :-----: | :-: | :--: |
+| Pure Rust  | Yes | No  |  Yes  |  Yes  |   Yes   |   Yes   | Yes | Yes  |
+| Accelerate | Yes | No  |  No   |  Yes  |   No    |   No    | Yes |  No  |
+| Netlib     | Yes | No  |  Yes  |  Yes  |   Yes   |   No    | No  |  No  |
+| Openblas   | Yes | No  |  Yes  |  Yes  |   Yes   |   Yes   | Yes |  No  |
diff --git a/burn-tch/README.md b/burn-tch/README.md
@@ -43,3 +43,12 @@ mod tch_cpu {
     }
 }
 ```
+
+### Platform Support
+
+| Option | CPU | GPU | Linux | MacOS | Windows | Android | iOS | WASM |
+| :----- | :-: | :-: | :---: | :---: | :-----: | :-----: | :-: | :--: |
+| CPU    | Yes | No  |  Yes  |  Yes  |   Yes   |   Yes   | Yes |  No  |
+| CUDA   | No  | Yes |  Yes  |  No   |   Yes   |   No    | No  |  No  |
+| MPS    | No  | Yes |  No   |  Yes  |   No    |   No    | No  |  No  |
+| Vulkan | Yes | Yes |  Yes  |  Yes  |   Yes   |   Yes   | No  |  No  |
diff --git a/burn-wgpu/README.md b/burn-wgpu/README.md
@@ -6,7 +6,7 @@
 [![license](https://shields.io/badge/license-MIT%2FApache--2.0-blue)](https://github.com/burn-rs/burn-wgpu/blob/master/README.md)
 
 This crate provides a WGPU backend for [Burn](https://github.com/burn-rs/burn) using the
-[wgpu](https://github.com/gfx-rs/wgpu). 
+[wgpu](https://github.com/gfx-rs/wgpu).
 
 The backend supports Vulkan, Metal, DirectX11/12, OpenGL, WebGPU.
 
@@ -29,3 +29,13 @@ mod wgpu {
 ## Configuration
 
 You can set `BURN_WGPU_MAX_TASKS` to a positive integer that determines how many computing tasks are submitted in batches to the graphics API.
+
+## Platform Support
+
+| Option    | CPU | GPU | Linux | MacOS | Windows | Android | iOS | WASM |
+| :-------- | :-: | :-: | :---: | :---: | :-----: | :-----: | :-: | :--: |
+| Metal     | No  | Yes |  No   |  Yes  |   No    |   No    | Yes |  No  |
+| Vulkan    | Yes | Yes |  Yes  |  Yes  |   Yes   |   Yes   | Yes |  No  |
+| OpenGL    | No  | Yes |  Yes  |  Yes  |   Yes   |   Yes   | Yes |  No  |
+| WebGpu    | No  | Yes |  No   |  No   |   No    |   No    | No  | Yes  |
+| Dx11/Dx12 | No  | Yes |  No   |  No   |   Yes   |   No    | No  |  No  |