mkdocs.yml

nav:
    - Home: index.md
    - Getting started:
          - KServe Quickstart: get_started/README.md
          - First InferenceService: get_started/first_isvc.md
    - Administration Guide:
          - Install KServe:
                - Serverless installation: admin/serverless.md
                - ModelMesh installation: admin/modelmesh.md
                - Kubernetes deployment installation: admin/kubernetes_deployment.md
                - Migrating from KFServing: admin/migration.md
    - User Guide:
          - Concepts:
                - Control Plane:
                  - Model Serving Control Plane: modelserving/control_plane.md
                - Data Plane:
                  - Model Serving Data Plane: modelserving/data_plane.md
                  - V2 Inference Protocol: modelserving/inference_api.md
                - Serving Runtimes: modelserving/servingruntimes.md
          - Single Model Serving:
              - Supported Model Frameworks/Formats:
                - Overview: modelserving/v1beta1/serving_runtime.md
                - Tensorflow: modelserving/v1beta1/tensorflow/README.md
                - PyTorch: modelserving/v1beta1/torchserve/README.md
                - Scikit-learn: modelserving/v1beta1/sklearn/v2/README.md
                - XGBoost: modelserving/v1beta1/xgboost/README.md
                - PMML: modelserving/v1beta1/pmml/README.md
                - Spark MLlib: modelserving/v1beta1/spark/README.md
                - LightGBM: modelserving/v1beta1/lightgbm/README.md
                - Paddle: modelserving/v1beta1/paddle/README.md
                - MLFlow: modelserving/v1beta1/mlflow/v2/README.md
              - Multi-Framework Serving Runtimes:
                - Nvidia Triton:
                  - Torchscript: modelserving/v1beta1/triton/torchscript/README.md
                  - Tensorflow: modelserving/v1beta1/triton/bert/README.md
              - How to write a custom predictor: modelserving/v1beta1/custom/custom_model/README.md
          - Multi Model Serving:
                - Overview:
                  - The Scalability Problem: modelserving/mms/multi-model-serving.md
                  - ModelMesh Overview: modelserving/mms/modelmesh/overview.md
          - Transformers:
                - Feast: modelserving/v1beta1/transformer/feast/README.md
                - How to write a custom transformer: modelserving/v1beta1/transformer/torchserve_image_transformer/README.md
          - Inference Graph:
                - Concept: modelserving/inference_graph/README.md
                - Image classification inference graph: modelserving/inference_graph/image_pipeline/README.md
          - Model Storage:
                - Azure: modelserving/storage/azure/azure.md
                - PVC: modelserving/storage/pvc/pvc.md
                - S3: modelserving/storage/s3/s3.md
                - URI: modelserving/storage/uri/uri.md
          - Model Explainability:
                - Concept: modelserving/explainer/explainer.md
                - Alibi Explainer:
                  - Image Explainer: modelserving/explainer/alibi/cifar10/README.md
                  - Income Explainer: modelserving/explainer/alibi/income/README.md
                  - Text Explainer: modelserving/explainer/alibi/moviesentiment/README.md
                - AIX Explainer: modelserving/explainer/aix/mnist/aix.md
          - Model Monitoring:
                - Alibi Detector: modelserving/detect/alibi_detect/alibi_detect.md
                - AIF Bias Detector: modelserving/detect/aif/germancredit/README.md
                - ART Adversarial Detector: modelserving/detect/art/mnist/README.md
          - Request Batching:
                - Inference Batcher: modelserving/batcher/batcher.md
          - Payload Logging:
                - Inference Logger: modelserving/logger/logger.md
          - Autoscaling:
                - Inference Autoscaling: modelserving/autoscaling/autoscaling.md
          - Node Scheduling:
                - Overview: modelserving/nodescheduling/overview.md
                - InferenceService Node Scheduling: modelserving/nodescheduling/inferenceservicenodescheduling.md
          - Kafka:
                - Inference with Kafka event source: modelserving/kafka/kafka.md
          - Rollout Strategies:
                - Canary:  modelserving/v1beta1/rollout/canary.md
                - Canary Example: modelserving/v1beta1/rollout/canary-example.md
    - API Reference:
          - Control Plane API: reference/api.md
          - Python Client SDK: sdk_docs/sdk_doc.md
    - Developer Guide:
          - How to contribute: developer/developer.md
          - Debugging guide: developer/debug.md
    - Blog:
          - Releases:
            - KServe 0.9 Release: blog/articles/2022-07-21-KServe-0.9-release.md
            - KServe 0.8 Release: blog/articles/2022-02-18-KServe-0.8-release.md
            - KServe 0.7 Release: blog/articles/2021-10-11-KServe-0.7-release.md
          - Articles:
            - KFserving Transition: blog/articles/2021-09-27-kfserving-transition.md
    - Community:
        - Adopters: community/adopters.md
        - Demos and Presentations: community/presentations.md

site_name: KServe Documentation Website
site_url: https://kserve.io/website
site_description: KServe Documentation
extra_css:
  - stylesheets/extra.css

repo_url: https://github.com/kserve/website
edit_uri: edit/main/docs

theme:
  name: material
  logo: images/logo/kserve.png
  favicon: images/favicon/favicon-32x32.png
  custom_dir: overrides
  features:
    - navigation.tabs
    - navigation.tracking
    - navigation.tabs.sticky
    - navigation.top

markdown_extensions:
  # - mdx_include:
  #     base_path: docs
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - attr_list
  - meta
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.snippets:
      base_path: docs/snippets
  - pymdownx.keys
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.escapeall
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - toc:
      permalink: true
  - def_list

copyright: "Copyright © 2021 The KServe Authors"

plugins:
  - search
  - mike:
     version_selector: true
     css_dir: css
     javascript_dir: js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/kserve
      name: KServe Community on Github
    - icon: fontawesome/brands/slack
      link: https://kubeflow.slack.com/join/shared_invite/zt-n73pfj05-l206djXlXk5qdQKs4o1Zkg#
      name: Slack
  # TODO: Replace with https://github.com/mkdocs/mkdocs/pull/2267 once mkdocs 1.2 is out.
  version_warning: !!python/object/apply:os.getenv ["VERSION_WARNING"]
  kserve_version: !!python/object/apply:os.getenv ["KSERVE_VERSION"]
  branch: !!python/object/apply:os.getenv ["SAMPLES_BRANCH", "mkdocs"]
  version:
    provider: mike