[PR #294] [CLOSED] - [x] Polish docs #349

New issue

Closed

opened 2026-10-26 21:16:33 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-26 21:16:33 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/deepseek-ai/DeepGEMM/pull/294
Author: @ajwise9
Created: 3/22/2026
Status: ❌ Closed

Base: main ← Head: polish-docs

📝 Commits (2)

78e97ca Better error handling, code consistency, compile-time safety
e8d4294 - [x] Polish docs

📊 Changes

2 files changed (+21 additions, -5 deletions)

View changed files

📝 README.md (+20 -4)
📝 setup.py (+1 -1)

📄 Description

Just reading through the docs and noticed some things needed a bit of polishing, so went ahead and cleaned them up here:

Removed the stale (working in progress) from BF16 since it looks fully shipped.
Fixed a broken link to tests/test_core.py in the quickstart that doesn't exist anymore and replaced it with test_fp8.py, test_bf16.py, test_einsum.py.
Documented einsum and fp8_einsum in the interfaces and utilities since they are exported APIs.
Briefly mentioned fp8_gemm_nt_skip_head_mid.

Hope this helps!

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/deepseek-ai/DeepGEMM/pull/294 **Author:** [@ajwise9](https://github.com/ajwise9) **Created:** 3/22/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `polish-docs` --- ### 📝 Commits (2) - [`78e97ca`](https://github.com/deepseek-ai/DeepGEMM/commit/78e97caffe99a51cff5a9a660dde8682fa8c7fb7) Better error handling, code consistency, compile-time safety - [`e8d4294`](https://github.com/deepseek-ai/DeepGEMM/commit/e8d42947c6d671a4be072f900e77420c754bbfa0) - [x] Polish docs ### 📊 Changes **2 files changed** (+21 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+20 -4) 📝 `setup.py` (+1 -1) </details> ### 📄 Description Just reading through the docs and noticed some things needed a bit of polishing, so went ahead and cleaned them up here: - Removed the stale *(working in progress)* from BF16 since it looks fully shipped. - Fixed a broken link to `tests/test_core.py` in the quickstart that doesn't exist anymore and replaced it with [test_fp8.py](cci:7://file:///Users/ajwise/Desktop/work/GitHub/DeepGEMM/tests/test_fp8.py:0:0-0:0), [test_bf16.py](cci:7://file:///Users/ajwise/Desktop/work/GitHub/DeepGEMM/tests/test_bf16.py:0:0-0:0), [test_einsum.py](cci:7://file:///Users/ajwise/Desktop/work/GitHub/DeepGEMM/tests/test_einsum.py:0:0-0:0). - Documented `einsum` and `fp8_einsum` in the interfaces and utilities since they are exported APIs. - Briefly mentioned `fp8_gemm_nt_skip_head_mid`. Hope this helps! --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-26 21:16:33 +00:00