site_name: mi_crow
site_description: Explaining and modifying LLM responses using SAE and concepts
site_url: https://adamkaniasty.github.io/Inzynierka
repo_url: https://github.com/AdamKaniasty/Inzynierka
repo_name: AdamKaniasty/Inzynierka
edit_uri: blob/main/

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - content.code.copy
    - content.action.edit
  palette:
    - scheme: default

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            merge_init_into_class: true
            separate_signature: true
            heading_level: 2
  - section-index
  - redirects

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets

nav:
  - Home: index.md
  - User Guide:
    - guide/index.md
    - guide/installation.md
    - guide/quickstart.md
    - guide/core-concepts.md
    - Hooks System:
      - guide/hooks/index.md
      - guide/hooks/fundamentals.md
      - guide/hooks/detectors.md
      - guide/hooks/controllers.md
      - guide/hooks/registration.md
      - guide/hooks/advanced.md
    - Workflows:
      - guide/workflows/index.md
      - guide/workflows/saving-activations.md
      - guide/workflows/training-sae.md
      - guide/workflows/concept-discovery.md
      - guide/workflows/concept-manipulation.md
      - guide/workflows/activation-control.md
    - guide/best-practices.md
    - guide/troubleshooting.md
    - guide/examples.md
  - Experiments:
    - experiments/index.md
    - experiments/verify-sae-training.md
    - experiments/slurm-pipeline.md
  - API Reference:
    - api.md
    - api/index.md
    - Language Model: api/language_model.md
    - SAE: api/sae.md
    - Datasets: api/datasets.md
    - Store: api/store.md
    - Hooks: api/hooks.md
