.. Arrakis documentation master file, created by
   sphinx-quickstart on Wed Jun 26 13:03:08 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


Arrakis's documentation!
===================================

.. toctree::
   :maxdepth: 1
   :caption: Contents:
   
   README
   AttentionHeadComposition
   AttentionTools
   CausalTracingIntervention
   FeatureVisualization
   KnowledgeGraphExtractor
   KnowledgeProber
   LogitAttribution
   LogitLens
   ModelSurgery
   ReadWriteHeads
   ResidualDecomposer
   ResidualTools
   SparsityAnalyzer
   SuperpositionDisentangler

AttentionHeadComposition
------------------------
.. automodule:: core_arrakis.attention_head_comp
   :members:
   :undoc-members:
   :show-inheritance:

AttentionTools
--------------
.. automodule:: core_arrakis.attention_tools
   :members:
   :undoc-members:
   :show-inheritance:

CausalTracingIntervention
-------------------------
.. automodule:: core_arrakis.causal_tracing_intervention
   :members:
   :undoc-members:
   :show-inheritance:

KnowledgeGraphExtractor
-----------------------
.. automodule:: core_arrakis.kg_extractor
   :members:
   :undoc-members:
   :show-inheritance:

KnowledgeProber
---------------
.. automodule:: core_arrakis.knowledge_prober
   :members:
   :undoc-members:
   :show-inheritance:

LogitAttribution
----------------
.. automodule:: core_arrakis.logit_attribution
   :members:
   :undoc-members:
   :show-inheritance:

LogitLens
---------
.. automodule:: core_arrakis.logit_lens
   :members:
   :undoc-members:
   :show-inheritance:

ModelSurgery
------------
.. automodule:: core_arrakis.model_surgery
   :members:
   :undoc-members:
   :show-inheritance:

ReadWriteHeads
--------------
.. automodule:: core_arrakis.read_write_heads
   :members:
   :undoc-members:
   :show-inheritance:

ResidualDecomposer
------------------
.. automodule:: core_arrakis.residual_decomposer
   :members:
   :undoc-members:
   :show-inheritance:

ResidualTools
-------------
.. automodule:: core_arrakis.residual_tools
   :members:
   :undoc-members:
   :show-inheritance:

SparsityAnalyzer
----------------
.. automodule:: core_arrakis.sparsity_analyzer
   :members:
   :undoc-members:
   :show-inheritance:

SuperpositionDisentangler
-------------------------
.. automodule:: core_arrakis.superposition_disentangler
   :members:
   :undoc-members:
   :show-inheritance: