mkdocs.yml

site_name: 🦑 TruLens
site_description: Evaluate and track LLM applications. Explain Deep Neural Nets.

repo_name: truera/trulens
repo_url: https://github.com/truera/trulens

markdown_extensions:
  # Note: disabled most extensions are they were interfering with each other and
  # rendering things poorly.

  # https://squidfunk.github.io/mkdocs-material/reference/mathjax/
  #- pymdownx.arithmatex:
  #    generic: true
  - admonition
  #- codehilite:
  #    guess_lang: true
  #- footnotes
  - toc:
      permalink: true
  #- pymdownx.arithmatex
  #- pymdownx.betterem:
  #    smart_enable: all
  #- pymdownx.caret
  #- pymdownx.critic
  # - pymdownx.details
  # - pymdownx.extra
  # - pymdownx.inlinehilite
  - pymdownx.magiclink
  # - pymdownx.mark
  # - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  # - pymdownx.tasklist:
  #    custom_checkbox: true
  #- pymdownx.tilde
  #- mdx_math:
  #    enable_dollar_delimiter: True #for use of inline $..$
  - markdown_include.include:
      base_path: docs
  - attr_list

watch:
  - src

plugins:
  - blog
  - include-markdown:
      preserve_includer_indent: false
      dedent: false
      trailing_newlines: true
      comments: true
      rewrite_relative_urls: true
      heading_offset: 0
  - search
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocs-jupyter:
      include: ["*.ipynb"]
  - mkdocstrings:
      # See https://mkdocstrings.github.io/python/usage/configuration/docstrings/ .
      default_handler: python
      handlers:
        python:
          import:
            # These allow for links to types defined by various packages.
            - https://docs.python.org/3/objects.inv
            - https://docs.scipy.org/doc/numpy/objects.inv
            - https://api.python.langchain.com/en/latest/objects.inv
            - http://pandas.pydata.org/pandas-docs/stable/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
            - https://typing-extensions.readthedocs.io/en/latest/objects.inv
            - https://docs.llamaindex.ai/en/stable/objects.inv
            - https://docs.sqlalchemy.org/en/20/objects.inv
          paths:
            - src/core
            - src/feedback
            - src/dashboard
            - src/benchmark
            - src/apps/langchain
            - src/apps/llamaindex
            - src/apps/nemo
            - src/providers/bedrock
            - src/providers/cortex
            - src/providers/huggingface
            - src/providers/langchain
            - src/providers/litellm
            - src/providers/openai
            - src/connectors/snowflake
            - src/trulens_eval # to remove after deprecation
            - examples/
          options:

            heading_level: 2
            annotations_path: brief
            extensions:
              - pydantic: { schema: true }

            inherited_members: true
            show_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            separate_signature: true

            line_length: 60

            docstring_style: google
            docstring_section_style: spacy

            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_attributes: true
            show_category_heading: true
            show_submodules: false
            group_by_category: true

            show_source: false
            show_root_heading: true
            show_if_no_docstring: false
            members_order: source
            allow_inspection: true
            # load_external_modules: true
            #preload_modules:
            #- __future__
            #- builtins
            #- datetime
            #- pandas
            # - numpy # some error occurs
            #- pydantic
            #- llama_index
            #- typing
            #- typing_extensions
            # members:
            # filters:
            #   - "!^_" # exclude all members starting with _
            #   - "!^tru_class_info" # don't show tru_class_info
            #   - "^__init__$" # but always include __init__ modules and methods
            #   - "^__call__$" # and __call__ methods
          #selection:

  - redirects:
      redirect_maps:
        # These were distributed in the past but moved since then. Our own links
        # in the docs are updated but we keep these here for any distributed
        # links out there.
        # NOTE: Even though both the source and target in these maps refer to
        # ".md", the get interpreted (or maybe generated as) urls without ".md".
        # hack: old .ipynb files are set has .md because .ipynb not supported for old link
        trulens/install.md: getting_started/install.md
        trulens/core_concepts_feedback_functions.md: getting_started/core_concepts/feedback_functions.md
        trulens/core_concepts_rag_triad.md: getting_started/core_concepts/rag_triad.md
        trulens/core_concepts_honest_harmless_helpful_evals.md: getting_started/core_concepts/honest_harmless_helpful_evals.md
        trulens/quickstart.md: getting_started/quickstarts/quickstart.ipynb
        trulens/langchain_quickstart.md: getting_started/quickstarts/langchain_quickstart.ipynb
        trulens/llama_index_quickstart.md: getting_started/quickstarts/llama_index_quickstart.ipynb
        trulens/text2text_quickstart.md: getting_started/quickstarts/text2text_quickstart.ipynb
        trulens/groundtruth_evals.md: getting_started/quickstarts/groundtruth_evals.ipynb
        trulens/human_feedback.md: getting_started/quickstarts/human_feedback.ipynb
        trulens/release_blog_1dot.md: blog/posts/release_blog_1dot.md

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  custom_dir: docs/overrides/
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: trulens-light
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  #font:
  #  text: Source Sans Pro
  favicon: img/favicon.ico
  logo: img/squid.png
  features:
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
    # - navigation.instant
    # - navigation.instant.progress
    - navigation.indexes
    - navigation.top
    - navigation.tabs
    - navigation.sections
    # - navigation.expand
    - navigation.tracking
    - navigation.path
    - search.share
    - search.suggest
    - search.highlight
    - toc.follow
    # - toc.integrate
    - content.code.copy
    - content.tabs

nav:
  - 🏠 Home: index.md
  - 🚀 Getting Started:
      - getting_started/index.md
      - 📓 Quickstarts:
          # - getting_started/quickstarts/index.md
          # Title labels of these notebooks come from within the notebooks
          # themselves and will be overridden if specified here.
          - getting_started/quickstarts/quickstart.ipynb
          - getting_started/quickstarts/add_dataframe_quickstart.ipynb
          - getting_started/quickstarts/existing_data_quickstart.ipynb
          - getting_started/quickstarts/langchain_quickstart.ipynb
          - getting_started/quickstarts/llama_index_quickstart.ipynb
          - getting_started/quickstarts/text2text_quickstart.ipynb
          - getting_started/quickstarts/groundtruth_evals.ipynb
          - getting_started/quickstarts/human_feedback.ipynb
          - getting_started/quickstarts/groundtruth_evals_for_retrieval_systems.ipynb
          - getting_started/quickstarts/groundtruth_dataset_persistence.ipynb
          - getting_started/quickstarts/custom_stream.ipynb
      - ⭐ Core Concepts:
          - getting_started/core_concepts/index.md
          - ☔ Feedback Functions: getting_started/core_concepts/feedback_functions.md
          - ⟁ RAG Triad: getting_started/core_concepts/rag_triad.md
          - 🏆 Honest, Harmless, Helpful Evals: getting_started/core_concepts/honest_harmless_helpful_evals.md
      - 🎈Viewing Results:
          - getting_started/dashboard/index.md
  - 🗺️ Component Guides:
    - Instrumentation:
        - component_guides/instrumentation/index.md
        # Titles set inside notebooks and will be overridden if provider here.
        - component_guides/instrumentation/langchain.md
        - component_guides/instrumentation/llama_index.md
        - component_guides/instrumentation/nemo.md
    - Logging:
        - component_guides/logging/where_to_log/index.md
        - ❄️ Logging in Snowflake: component_guides/logging/where_to_log/log_in_snowflake.md
        - Logging Methods: component_guides/logging/logging.ipynb
    - 🎯 Evaluation:
        - component_guides/evaluation/index.md
        - Anatomy of a Feedback Function: component_guides/evaluation/feedback_anatomy.md
        - Feedback Implementations:
            - component_guides/evaluation/feedback_implementations/index.md
            - Stock Feedback Functions: component_guides/evaluation/feedback_implementations/stock.md
            - component_guides/evaluation/feedback_implementations/custom_feedback_functions.ipynb
        - Feedback Selectors:
            - component_guides/evaluation/feedback_selectors/index.md
            - Selecting Components: component_guides/evaluation/feedback_selectors/selecting_components.md
            - Selector Shortcuts: component_guides/evaluation/feedback_selectors/selector_shortcuts.md
        - Feedback Aggregation:
            - component_guides/evaluation/feedback_aggregation.md
        - Running Feedback Functions:
            # PLACEHOLDER: - evaluation/running_feedback_functions/index.md
            - Running with your app: component_guides/evaluation/running_feedback_functions/with_app.md
            - Running on existing data: component_guides/evaluation/running_feedback_functions/existing_data.md
        - Generating Test Cases:
            - component_guides/evaluation/generate_test_cases.md
    - 📊 Evaluation Benchmarks:
        - component_guides/evaluation_benchmarks/index.md
        - Answer Relevance Benchmark (small): component_guides/evaluation_benchmarks/answer_relevance_benchmark_small.ipynb
        - Comprehensiveness Benchmark: component_guides/evaluation_benchmarks/comprehensiveness_benchmark.ipynb
        - Context Relevance Benchmark (small): component_guides/evaluation_benchmarks/context_relevance_benchmark_small.ipynb
        - Context Relevance Benchmark (large): component_guides/evaluation_benchmarks/context_relevance_benchmark.ipynb
        - Groundedness Benchmark: component_guides/evaluation_benchmarks/groundedness_benchmark.ipynb
    - 🛡️ Guardrails:
        - component_guides/guardrails/index.md
    - Other:
      - Moving from TruLens Eval: component_guides/other/trulens_eval_migration.md
      - Uninstalling TruLens: component_guides/other/uninstalling.md
  - 📚 API Reference: reference/
  - 🧑‍🍳 Cookbook: cookbook/
  - 🤝 Contributing:
      - contributing/index.md
      - 🧭 Design: contributing/design.md
      - 📦 Release Policies: contributing/policies.md
      - ✅ Standards: contributing/standards.md
      - 💣 Tech Debt: contributing/techdebt.md
      - ⛅ Optional Packages: contributing/optional.md
      - ✨ Database Migration: contributing/migration.md
      - 🏁 Release History: contributing/release_history.md
  - ✍️ Blog:
      - blog/index.md

#  - Resources:
#    - NeurIPS Demo: https://truera.github.io/neurips-demo-2021/
extra:
  analytics:
      provider: google
      property: G-VE9D0QFFKD
  generator: false

extra_css:
  - stylesheets/extra.css

# https://squidfunk.github.io/mkdocs-material/reference/mathjax/
# Polyfill provides backcompat for JS. We need to import it before
# importing MathJax.
extra_javascript:
  - javascript/config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - javascript/tex-mml-chtml-3.0.0.js
  - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascript/tablesort.js