kapil commited on
Commit
c6c01fc
·
1 Parent(s): a6578e7

docs: add hardware optimization and VRAM management guide to README

Browse files
Files changed (1) hide show
  1. README.md +17 -0
README.md CHANGED
@@ -92,6 +92,23 @@ Package the engine as a library for direct hardware-accelerated execution on mob
92
 
93
  ---
94
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
95
  ## Technical Status and Contributing
96
 
97
  > [!IMPORTANT]
 
92
 
93
  ---
94
 
95
+ ## Hardware Optimization
96
+
97
+ This engine is optimized for GPU execution using the WGPU backend. Depending on your specific hardware, you may need to adjust the training intensity:
98
+
99
+ ### GPU VRAM Management
100
+ If you encounter **Out-of-Memory (OOM)** errors during training, you should reduce the **Batch Size**.
101
+
102
+ - **Where to change**: Open `src/main.rs` and modify the `batch_size` parameter.
103
+ - **Recommendations**:
104
+ - **4GB VRAM**: Batch Size 1 (Safe default)
105
+ - **8GB VRAM**: Batch Size 4
106
+ - **12GB+ VRAM**: Batch Size 8
107
+ - **RTX 5080 High-End**: Batch Size 16 (Optimal for ultra-fast convergence)
108
+ - **Impact**: Larger batch sizes provide more stable gradients but require exponentially more VRAM.
109
+
110
+ ---
111
+
112
  ## Technical Status and Contributing
113
 
114
  > [!IMPORTANT]