Language-Model-SAEs icon indicating copy to clipboard operation
Language-Model-SAEs copied to clipboard

[Proposal] Documentation coverage and static documentation site

Open dest1n1s opened this issue 1 year ago • 0 comments

It is much easier for people (who may be new to mechanistic interpretability) to get started with detailed tutorial and documentation. Currently this project lacks documentation and comments in many modules. We should raise the documentation coverage, to ensure detailed explanation of every part of our library.

Furthermore, we should consider building a static documentation site with tools like MkDocs. This helps people get an overview of the usage of the library without actually downloading it.

dest1n1s avatar Jun 08 '24 15:06 dest1n1s