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.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:
    - trulens_explain/trulens
    - trulens_eval/trulens_eval

plugins:
  - search
  - mkdocs-jupyter
  - 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
          options:
            extensions:
            - pydantic: {schema: 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

            # summary: true
            show_source: false
            show_root_heading: true
            show_if_no_docstring: false
            members_order: source
            # members: true
            allow_inspection: true
            # load_external_modules: true
            # unwrap_annotated: true
            #preload_modules:
              #- __future__
              #- builtins
              #- datetime
              #- pandas
              # - numpy # some error occurs
              #- pydantic
              #- llama_index
              #- typing
              #- typing_extensions
          paths:
            - trulens_explain
            - trulens_eval
          selection:
            filters:
              - "!^_" # exlude all members starting with _
              - "^__init__$" # but always include __init__ modules and methods
              - "^__call__$" # and __call__ methods


theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  custom_dir: docs/overrides/
  palette:
    scheme: trulens
  #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
    - toc.follow
    # - toc.integrate
    - content.code.copy

nav:
  - 🏠 Home: index.md
  - 🚀 Getting Started:
      - Installation: trulens_eval/install.md
      - 📓 Quickstarts:
      # Title labels of these notebooks come from within the notebooks
      # themselves and will be overridden if specified here.
          - trulens_eval/quickstart.ipynb
          - trulens_eval/langchain_quickstart.ipynb
          - trulens_eval/llama_index_quickstart.ipynb
          - trulens_eval/text2text_quickstart.ipynb
          - trulens_eval/groundtruth_evals.ipynb
          - trulens_eval/human_feedback.ipynb
      - Core Concepts:
          - Feedback Functions: trulens_eval/core_concepts_feedback_functions.md
          - RAG Triad: trulens_eval/core_concepts_rag_triad.md
          - Honest, Harmless, Helpful Evals: trulens_eval/core_concepts_honest_harmless_helpful_evals.md
  - 🎯 Evaluation:
      - Feedback Function Overview:
          - What is a Feedback Function?: trulens_eval/feedback_function_overview.md
          - Anatomy of a Feedback Function: trulens_eval/feedback_function_anatomy.md
      - Running Feedback Functions:
          - Running with your app: trulens_eval/feedback_functions_running_with_app.md
          - Running on existing data: trulens_eval/feedback_functions_existing_data.md
      - Feedback Selectors:
          - Overview: trulens_eval/feedback_selectors.md
          - Selecting Components: trulens_eval/selecting_components.md
          - Available shortcuts: trulens_eval/selector_shortcuts.md
      - Feedback Providers:
          - Classification: trulens_eval/classification_providers.md
          - Generation: trulens_eval/generation_providers.md
          #- LLMProvider:
          #  - Base: trulens_eval/api/provider/llmprovider.md
          #  - OpenAI:
          #    - Base: trulens_eval/api/provider/openai.md
          #    - AzureOpenAI: trulens_eval/api/provider/azureopenai.md
          #  - AWS Bedrock: trulens_eval/api/provider/bedrock.md
          #  - LiteLLM: trulens_eval/api/provider/litellm.md
          #  - 🦜️🔗 Langchain: trulens_eval/api/provider/langchain.md
          #- 🤗 HuggingFace: trulens_eval/api/provider/huggingface.md
      - Feedback Implementations:
          - 📖 Stock Feedback Functions: trulens_eval/api/providers.md
          - trulens_eval/custom_feedback_functions.ipynb
      - Generating Test Cases: trulens_eval/generate_test_cases.md
      - Feedback Evaluations:
          # Titles come from notebook and will be overridden if specified here.
          - trulens_eval/answer_relevance_smoke_tests.ipynb
          - trulens_eval/context_relevance_smoke_tests.ipynb
          - trulens_eval/groundedness_smoke_tests.ipynb
  - 🎺 Tracking:
      - Instrumentation:
          # Titles set inside notebooks and will be overridden if provider here.
          - trulens_eval/trulens_instrumentation.ipynb
          - trulens_eval/langchain_instrumentation.ipynb
          - trulens_eval/llama_index_instrumentation.ipynb
      - Logging:
          - Where to Log: trulens_eval/where_to_log.md
          - 📓 Logging Methods: trulens_eval/logging.ipynb
  - 🔍 Guides:
      - Any LLM App: trulens_eval/use_cases_any.md
      - RAGs: trulens_eval/use_cases_rag.md
      - LLM Agents: trulens_eval/use_cases_agent.md
      - Dev to Prod: trulens_eval/use_cases_production.md
  - ☕ API Reference:
          - 🦑 Tru: trulens_eval/api/tru.md
          - App:
            - App(Definition): trulens_eval/api/app/app.md
            - TruBasicApp: trulens_eval/api/app/trubasicapp.md
            - 🦜️🔗 TruChain: trulens_eval/api/app/truchain.md
            - 🦙 TruLlama: trulens_eval/api/app/trullama.md
            - TruCustom: trulens_eval/api/app/trucustom.md
            - TruVirtual: trulens_eval/api/app/truvirtual.md
          - Feedback: trulens_eval/api/feedback.md
          - Record: trulens_eval/api/record.md
          - Provider:
            - Base: trulens_eval/api/provider/provider.md
            - LLMProvider: trulens_eval/api/provider/llmprovider.md
            - OpenAI:
              - Base: trulens_eval/api/provider/openai.md
              - AzureOpenAI: trulens_eval/api/provider/azureopenai.md
            - AWS Bedrock: trulens_eval/api/provider/bedrock.md
            - LiteLLM: trulens_eval/api/provider/litellm.md
            - 🦜️🔗 Langchain: trulens_eval/api/provider/langchain.md
            - 🤗 HuggingFace: trulens_eval/api/provider/huggingface.md
            - Endpoint:
              - Base: trulens_eval/api/endpoint/base.md
              - OpenAI: trulens_eval/api/endpoint/openai.md
          - Utils: 
            - trulens_eval/api/utils/python.md
            - trulens_eval/api/utils/serial.md
            - trulens_eval/api/utils/frameworks.md
            - trulens_eval/api/utils/utils.md
  - 🤝 Contributing:
      - Contribution Guidelines: trulens_eval/CONTRIBUTING.md
      - Standards: trulens_eval/STANDARDS.md
  - ❓ Explain:
      - Getting Started:
          - Installation: trulens_explain/install.md
          - Quickstart: trulens_explain/quickstart.md
      - Attributions: trulens_explain/attribution_parameterization.md
      - ☕ API Reference:
          - Attribution: trulens_explain/api/attribution.md
          - Models: trulens_explain/api/model_wrappers.md
          - Slices: trulens_explain/api/slices.md
          - Quantities: trulens_explain/api/quantities.md
          - Distributions: trulens_explain/api/distributions.md
          - Visualizations: trulens_explain/api/visualizations.md
#  - Resources:
#    - NeurIPS Demo: https://truera.github.io/neurips-demo-2021/

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