chore: improving mkdocs setup with mike #487
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
Author
|
merging as this should be non-controversial |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #487 +/- ##
=======================================
Coverage 75.14% 75.14%
=======================================
Files 19 19
Lines 3171 3171
Branches 458 458
=======================================
Hits 2383 2383
Misses 630 630
Partials 158 158 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
chanind
added a commit
that referenced
this pull request
May 28, 2025
chanind
added a commit
that referenced
this pull request
Jul 14, 2025
* Reorganized folders * fixing toolkit paths * First draft of base and standard SAEs * Working implementation of separated standard SAE * working, tested equivalents to old sae types * training SAE wrapper now passing tests * SAEs passing most tests * All tests passing with restructured SAE classes * HookedSAETransformer now passing tests * formatting fixes * importing changes to topk SAE aux loss from #432 * extracts logging fields to class (#444) * extracts logging fields to class * applies make format * fixes comment * changes default value for wandb_project * fixing equivalence tests * getting tests passing again * removing proxy classes * fixing type errors * move tests around * allow running deploy on alpha and beta branches BREAKING CHANGE: incompatible config structure * updating workflow to run on pushes to alpha and beta * updating semantic release config to hopefully run alpha/beta builds * feat: refactor config BREAKING CHANGE: refactor config options * 6.0.0-rc.1 Automatically generated by python-semantic-release * Refactor arch configs (#468) * wip: refactoring architecture configs * move to separate config classes per architecture * wip: fixing tests * working on getting more tests passing * fixing more tests / typing issues * adding support for converting from old config formats * fixing more tests * fixing more tests * fixing more tests and typings * fixing more tests * fixing linting * ensuring runner config is also uploaded if available * fix init to match old heuristic init * Update sae_lens/config.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/config.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/training/sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/refactor_compatibility/test_jumprelu_sae_equivalence.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/refactor_compatibility/test_jumprelu_sae_equivalence.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/util.py Co-authored-by: Anthony Duong <[email protected]> * changes from CR * fixing formatting * Update sae_lens/config.py Co-authored-by: Anthony Duong <[email protected]> * changes from CR * fixing registry.py naming * Update sae_lens/saes/sae.py Co-authored-by: Anthony Duong <[email protected]> * rename meta -> metadata * fixing tests * updating docs * fixing docs * fixing tests --------- Co-authored-by: Anthony Duong <[email protected]> * chore: versioned docs (#485) * feat: arch configs * 6.0.0-rc.2 Automatically generated by python-semantic-release * chore: improving mkdocs setup with mike (#487) * updating docs to install pre-release version of saelens * feat: Decouple training from LLM activation store / LLM evals (#496) * Refactor activations store to be an iterator * fixing some activations store tests * wip: removing hook_layer param * adding early stopping support to the HF model proxy wrapper * WIP removing dependency of act store and model from trainer * fixing tests * fixing activations cache runner * fixing linting and types * Update benchmark/test_language_model_sae_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update benchmark/test_language_model_sae_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update benchmark/test_language_model_sae_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update benchmark/test_language_model_sae_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update benchmark/test_language_model_sae_runner_multiple_devices.py Co-authored-by: Anthony Duong <[email protected]> * Update benchmark/test_language_model_sae_runner_multiple_devices.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_mixing_buffer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/llm_sae_training_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/llm_sae_training_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/load_model.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/training/activation_scaler.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/training/sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_activation_scaler.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_activation_scaler.py Co-authored-by: Anthony Duong <[email protected]> * fixes from CR * fixing type checking - thanks Anthony! * fixing formatting * fixing notebook * Update sae_lens/util.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/util.py Co-authored-by: Anthony Duong <[email protected]> * changes from CR --------- Co-authored-by: Anthony Duong <[email protected]> * 6.0.0-rc.3 Automatically generated by python-semantic-release * feat: Final 6.0.0 changes (#499) * fixing metadata issues in SAELens * changing from_pretrained() to directly return the SAE instead of a tuple of objects * fixing call error * fixing test_sae_fold_w_dec_norm_all_architectures * removing unused file * fixing bugs around serializing and unserializing configs * deleting layer_norm normalization - this is never used * removing mse_normalization, tanh-relu, and noise_scale, as these are basically never used * fixing test * fixing eval_all_loadable_saes benchmark * letting claude write some tests for neuronpedia integration * claude continuing to go ham on neuronpedia tests * fixing LLM CLI runner * fixing linting * turning SAEMetadata into more of a dict-like class to decouple it from LLM-trained SAEs * cleaning up tutorials * adding migration docs * further doc updates * Update docs/migrating.md Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/saes/sae.py Co-authored-by: Anthony Duong <[email protected]> * Update docs/training_saes.md Co-authored-by: Anthony Duong <[email protected]> * Update tests/test_llm_sae_training_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/training/sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * changes from CR * fixing formatting * fixing typing in test * fixing connor_rob_hook_z SAE loading * fixing hook_z reshaping for pretrained saes more robustly --------- Co-authored-by: Anthony Duong <[email protected]> * 6.0.0-rc.4 Automatically generated by python-semantic-release * try bumping cache to solve CI disk space issue * allow old usage of SAE.from_pretrained() to continue to work (#501) * feat: make from_pretrained() gracefully fall back to original behavior * 6.0.0-rc.5 Automatically generated by python-semantic-release --------- Co-authored-by: Curt Tigges <[email protected]> Co-authored-by: Curt Tigges <[email protected]> Co-authored-by: Anthony Duong <[email protected]> Co-authored-by: github-actions <[email protected]>
v-realm
pushed a commit
to realmlabs-ai/SAELens
that referenced
this pull request
Nov 15, 2025
v-realm
pushed a commit
to realmlabs-ai/SAELens
that referenced
this pull request
Nov 15, 2025
* Reorganized folders * fixing toolkit paths * First draft of base and standard SAEs * Working implementation of separated standard SAE * working, tested equivalents to old sae types * training SAE wrapper now passing tests * SAEs passing most tests * All tests passing with restructured SAE classes * HookedSAETransformer now passing tests * formatting fixes * importing changes to topk SAE aux loss from decoderesearch#432 * extracts logging fields to class (decoderesearch#444) * extracts logging fields to class * applies make format * fixes comment * changes default value for wandb_project * fixing equivalence tests * getting tests passing again * removing proxy classes * fixing type errors * move tests around * allow running deploy on alpha and beta branches BREAKING CHANGE: incompatible config structure * updating workflow to run on pushes to alpha and beta * updating semantic release config to hopefully run alpha/beta builds * feat: refactor config BREAKING CHANGE: refactor config options * 6.0.0-rc.1 Automatically generated by python-semantic-release * Refactor arch configs (decoderesearch#468) * wip: refactoring architecture configs * move to separate config classes per architecture * wip: fixing tests * working on getting more tests passing * fixing more tests / typing issues * adding support for converting from old config formats * fixing more tests * fixing more tests * fixing more tests and typings * fixing more tests * fixing linting * ensuring runner config is also uploaded if available * fix init to match old heuristic init * Update sae_lens/config.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/config.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/training/sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/refactor_compatibility/test_jumprelu_sae_equivalence.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/refactor_compatibility/test_jumprelu_sae_equivalence.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/util.py Co-authored-by: Anthony Duong <[email protected]> * changes from CR * fixing formatting * Update sae_lens/config.py Co-authored-by: Anthony Duong <[email protected]> * changes from CR * fixing registry.py naming * Update sae_lens/saes/sae.py Co-authored-by: Anthony Duong <[email protected]> * rename meta -> metadata * fixing tests * updating docs * fixing docs * fixing tests --------- Co-authored-by: Anthony Duong <[email protected]> * chore: versioned docs (decoderesearch#485) * feat: arch configs * 6.0.0-rc.2 Automatically generated by python-semantic-release * chore: improving mkdocs setup with mike (decoderesearch#487) * updating docs to install pre-release version of saelens * feat: Decouple training from LLM activation store / LLM evals (decoderesearch#496) * Refactor activations store to be an iterator * fixing some activations store tests * wip: removing hook_layer param * adding early stopping support to the HF model proxy wrapper * WIP removing dependency of act store and model from trainer * fixing tests * fixing activations cache runner * fixing linting and types * Update benchmark/test_language_model_sae_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update benchmark/test_language_model_sae_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update benchmark/test_language_model_sae_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update benchmark/test_language_model_sae_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update benchmark/test_language_model_sae_runner_multiple_devices.py Co-authored-by: Anthony Duong <[email protected]> * Update benchmark/test_language_model_sae_runner_multiple_devices.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_mixing_buffer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/llm_sae_training_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/llm_sae_training_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/load_model.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/training/activation_scaler.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/training/sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_activation_scaler.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_activation_scaler.py Co-authored-by: Anthony Duong <[email protected]> * fixes from CR * fixing type checking - thanks Anthony! * fixing formatting * fixing notebook * Update sae_lens/util.py Co-authored-by: Anthony Duong <[email protected]> * Update tests/training/test_sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/util.py Co-authored-by: Anthony Duong <[email protected]> * changes from CR --------- Co-authored-by: Anthony Duong <[email protected]> * 6.0.0-rc.3 Automatically generated by python-semantic-release * feat: Final 6.0.0 changes (decoderesearch#499) * fixing metadata issues in SAELens * changing from_pretrained() to directly return the SAE instead of a tuple of objects * fixing call error * fixing test_sae_fold_w_dec_norm_all_architectures * removing unused file * fixing bugs around serializing and unserializing configs * deleting layer_norm normalization - this is never used * removing mse_normalization, tanh-relu, and noise_scale, as these are basically never used * fixing test * fixing eval_all_loadable_saes benchmark * letting claude write some tests for neuronpedia integration * claude continuing to go ham on neuronpedia tests * fixing LLM CLI runner * fixing linting * turning SAEMetadata into more of a dict-like class to decouple it from LLM-trained SAEs * cleaning up tutorials * adding migration docs * further doc updates * Update docs/migrating.md Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/saes/sae.py Co-authored-by: Anthony Duong <[email protected]> * Update docs/training_saes.md Co-authored-by: Anthony Duong <[email protected]> * Update tests/test_llm_sae_training_runner.py Co-authored-by: Anthony Duong <[email protected]> * Update sae_lens/training/sae_trainer.py Co-authored-by: Anthony Duong <[email protected]> * changes from CR * fixing formatting * fixing typing in test * fixing connor_rob_hook_z SAE loading * fixing hook_z reshaping for pretrained saes more robustly --------- Co-authored-by: Anthony Duong <[email protected]> * 6.0.0-rc.4 Automatically generated by python-semantic-release * try bumping cache to solve CI disk space issue * allow old usage of SAE.from_pretrained() to continue to work (decoderesearch#501) * feat: make from_pretrained() gracefully fall back to original behavior * 6.0.0-rc.5 Automatically generated by python-semantic-release --------- Co-authored-by: Curt Tigges <[email protected]> Co-authored-by: Curt Tigges <[email protected]> Co-authored-by: Anthony Duong <[email protected]> Co-authored-by: github-actions <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds
mikeand the correctsite_urlfor the docs, so hopefully a version selector will render in docs moving foward