site_name: Deep Java Library
repo_name: deepjavalibrary/djl
repo_url: https://github.com/deepjavalibrary/djl
edit_uri: https://github.com/deepjavalibrary/djl/edit/master/
site_url: https://djl.ai
use_directory_urls: false
markdown_extensions:
  - codehilite
  - toc:
      permalink: true
theme:
  name: material
  logo: website/img/DJL.svg
  favicon: website/img/favicon.png
  features:
    - navigation.tabs
  palette:
    - scheme: default
      primary: light-blue
      accent: light-blue
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: deep-orange
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  edit_uri: ''

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/deepjavalibrary/djl
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/deepjavalibrary
    - icon: fontawesome/brands/slack
      link: https://join.slack.com/t/deepjavalibrary/shared_invite/zt-ar91gjkz-qbXhr1l~LFGEIEeGBibT7w
    - icon: fontawesome/brands/zhihu
      link: https://zhuanlan.zhihu.com/c_1255493231133417472
  analytics:
    provider: google
    property: G-JE0V807433
docs_dir: '../'
site_dir: '../../site'
plugins:
  - search
  - mknotebooks
  - mike
  - exclude:
      regex:
        - '.*\.(symbol|params|pt|jar|gz|zip|txt|json|sh|bat|cmd|puml|g4|java|py|cc|h|pro|properties|xml|html|scala|sbt|kt|npy|npz|onnx|rs|rst|safetensors|tar|toml|trt|vue|scss|yml|yaml|Dockerfile|cmake|RepositoryFactory|EngineProvider|ZooProvider)$|LICENSE|NOTICE|.*gradle.*|.*/mvnw|.*/Dockerfile.*|.*(hdpi|\.git|\.mvn|docker|buildSrc|gradle|integration|testing|jacoco|tools|javadoc|META-INF|/webapp|apache-spark/notebook|frontend)/.*'


nav:
  - Home:
      - Main: 'README.md'
      - 'docs/get.md'
      - 'docs/quick_start.md'
      - 'docs/README.md'
      - 'examples/README.md'
      - 'docs/interactive_tool.md'
      - Contributor Documentation:
          - Main: 'docs/development/README.md'
          - 'docs/development/setup.md'
          - 'docs/development/development_guideline.md'
          - 'docs/development/troubleshooting.md'
          - 'docs/development/dependency_management.md'
          - 'docs/development/add_model_to_model-zoo.md'
          - 'docs/development/add_dataset_to_djl.md'
      - 'docs/roadmap.md'
      - 'docs/faq.md'
  - Tutorials:
      - Beginner Tutorial:
          - 'docs/demos/jupyter/tutorial/01_create_your_first_network.ipynb'
          - 'docs/demos/jupyter/tutorial/02_train_your_first_model.ipynb'
          - 'docs/demos/jupyter/tutorial/03_image_classification_with_your_model.ipynb'
      - 'docs/d2l.md'
      - 'docs/demos/jupyter/rank_classification_using_BERT_on_Amazon_Review.ipynb'
      - 'docs/demos/jupyter/transfer_learning_on_cifar10.ipynb'
      - Load your own BERT:
          - BERT with MXNet: 'docs/demos/jupyter/mxnet/load_your_own_mxnet_bert.ipynb'
          - BERT with PyTorch: 'docs/demos/jupyter/pytorch/load_your_own_pytorch_bert.ipynb'
  - Guides:
      - Models:
          - 'docs/load_model.md'
          - 'docs/model-zoo.md'
      - Datasets:
          - 'docs/dataset.md'
          - 'docs/development/how_to_use_dataset.md'
      - Inference and Production:
          - 'docs/create_serving_ready_model.md'
          - 'docs/development/configure_logging.md'
          - 'docs/how_to_collect_metrics.md'
          - 'docs/development/inference_performance_optimization.md'
          - 'docs/development/profiler.md'
      - 'docs/development/cache_management.md'
      - 'docs/development/memory_management.md'
      - 'docs/cv_utils.md'
  - DJL Community:
      - 'docs/forums.md'
      - 'leaders.md'
  - Supported Engines:
      - Overview: 'docs/engine.md'
      - PyTorch:
          - Overview: 'engines/pytorch/README.md'
          - PyTorch Engine: 'engines/pytorch/pytorch-engine/README.md'
          - PyTorch NDArray Operators: 'docs/pytorch/pytorch-djl-ndarray-cheatsheet.md'
          - PyTorch Model Zoo: 'engines/pytorch/pytorch-model-zoo/README.md'
          - Import PyTorch Model: 'docs/pytorch/how_to_convert_your_model_to_torchscript.md'
          - Load a PyTorch Model: 'docs/demos/jupyter/load_pytorch_model.ipynb'
      - TensorFlow:
          - Overview: 'engines/tensorflow/README.md'
          - TensorFlow Engine: 'engines/tensorflow/tensorflow-engine/README.md'
          - TensorFlow Model Zoo: 'engines/tensorflow/tensorflow-model-zoo/README.md'
          - Import TensorFlow Model: 'docs/tensorflow/how_to_import_tensorflow_models_in_DJL.md'
          - Load a TensorFlow Model: 'docs/demos/jupyter/tensorflow/pneumonia_detection.ipynb'
      - Apache MXNet:
          - Overview: 'engines/mxnet/README.md'
          - MXNet Engine: 'engines/mxnet/mxnet-engine/README.md'
          - MXNet Model Zoo: 'engines/mxnet/mxnet-model-zoo/README.md'
          - Import Gluon Model: 'docs/mxnet/how_to_convert_your_model_to_symbol.md'
          - Load a MXNet Model: 'docs/demos/jupyter/load_mxnet_model.ipynb'
          - Backend Optimizer for MXNet: 'docs/mxnet/mxnet_backend_optimizer.md'
      - Hybrid engines:
          - Hybrid engine overview: 'docs/hybrid_engine.md'
          - ONNX Runtime:
              - Overview: 'engines/onnxruntime/onnxruntime-engine/README.md'
              - Load a ONNX Model: 'docs/demos/jupyter/onnxruntime/machine_learning_with_ONNXRuntime.ipynb'
          - XGBoost: 'engines/ml/xgboost/README.md'
          - LightGBM: 'engines/ml/lightgbm/README.md'
          - TensorRT: 'engines/tensorrt/README.md'
  - Extensions:
      - Android: 'android/README.md'
      - AWS S3 support: 'extensions/aws-ai/README.md'
      - Audio: 'extensions/audio/README.md'
      - fastText: 'extensions/fasttext/README.md'
      - Hadoop support: 'extensions/hadoop/README.md'
      - Huggingface Tokenizers: 'extensions/tokenizers/README.md'
      - OpenCV: 'extensions/opencv/README.md'
      - SentencePiece: 'extensions/sentencepiece/README.md'
      - Spark support: 'extensions/spark/README.md'
      - Tablesaw: 'extensions/tablesaw/README.md'
      - TimeSeries: 'extensions/timeseries/README.md'
      - DJL Zero: 'djl-zero/README.md'
      - DJL Benchmark: 'docs/serving/benchmark/README.md'
  - DJL Serving:
      - Why DJL Serving?: 'docs/serving/README.md'
      - 'docs/serving/serving/docs/starting.md'
      - 'docs/serving/serving/docs/inference.md'
      - 'docs/serving/serving/docs/modes.md'
      - 'docs/serving/serving/docs/console.md'
      - Configuration:
          - 'docs/serving/serving/docs/configuration.md'
          - 'docs/serving/serving/docs/configurations_global.md'
          - 'docs/serving/serving/docs/configurations.md'
          - 'docs/serving/serving/docs/workflows.md'
          - 'docs/serving/serving/docs/configurations_model.md'
      - 'docs/serving/serving/docs/architecture.md'
      - HTTP API:
          - 'docs/serving/serving/docs/inference_api.md'
          - 'docs/serving/serving/docs/management_api.md'
      - 'docs/serving/serving/docs/plugin_management.md'
      - 'docs/serving/wlm/README.md'
  - Large Model Inference:
      - 'docs/serving/serving/docs/lmi/README.md'
      - User Guides:
          - 'docs/serving/serving/docs/lmi/user_guides/README.md'
          - 'docs/serving/serving/docs/lmi/user_guides/starting-guide.md'
          - 'docs/serving/serving/docs/lmi/user_guides/lmi-dist_user_guide.md'
          - 'docs/serving/serving/docs/lmi/user_guides/vllm_user_guide.md'
          - 'docs/serving/serving/docs/lmi/user_guides/tnx_user_guide.md'
          - 'docs/serving/serving/docs/lmi/user_guides/trt_llm_user_guide.md'
          - 'docs/serving/serving/docs/lmi/user_guides/hf_accelerate.md'
          - 'docs/serving/serving/docs/lmi/user_guides/lmi_input_output_schema.md'
          - 'docs/serving/serving/docs/lmi/user_guides/chat_input_output_schema.md'
          - 'docs/serving/serving/docs/lmi/user_guides/output_formatter_schema.md'
          - 'docs/serving/serving/docs/lmi/user_guides/input_formatter_schema.md'
      - Deployment Guides:
          - 'docs/serving/serving/docs/lmi/deployment_guide/README.md'
          - 'docs/serving/serving/docs/lmi/deployment_guide/model-artifacts.md'
          - 'docs/serving/serving/docs/lmi/deployment_guide/instance-type-selection.md'
          - 'docs/serving/serving/docs/lmi/deployment_guide/backend-selection.md'
          - 'docs/serving/serving/docs/lmi/deployment_guide/configurations.md'
          - 'docs/serving/serving/docs/lmi/deployment_guide/deploying-your-endpoint.md'
          - 'docs/serving/serving/docs/lmi/deployment_guide/benchmarking-your-endpoint.md'
          - 'docs/serving/serving/docs/lmi/deployment_guide/testing-custom-script.md'
      - Tutorials:
          - 'docs/serving/serving/docs/lmi/tutorials/seq_scheduler_tutorial.md'
          - 'docs/serving/serving/docs/lmi/tutorials/trtllm_aot_tutorial.md'
          - 'docs/serving/serving/docs/lmi/tutorials/trtllm_manual_convert_tutorial.md'
          - 'docs/serving/serving/docs/lmi/tutorials/tnx_aot_tutorial.md'
      - Conceptual Guides:
          - 'docs/serving/serving/docs/lmi/conceptual_guide/lmi_engine.md'
      - SageMaker LMI containers resources:
          - 'docs/demos/aws/sagemaker/large-model-inference/README.md'
      - Releases:
          - 'docs/serving/serving/docs/lmi/user_guides/release_notes.md'
      - Announcements:
          - 'docs/serving/serving/docs/lmi/announcements/breaking_changes.md'
  - Demos:
      - Demos: 'docs/demos/README.md'
      - AWS:
          - Amazon SageMaker:
              - Start with SageMaker: 'docs/demos/aws/sagemaker/README.md'
              - SageMaker Notebook: 'docs/demos/aws/sagemaker/notebook/README.md'
              - SageMaker Studio: 'docs/demos/aws/sagemaker/studio/README.md'
          - AWS-kinesis-video-streams: 'docs/demos/aws/aws-kinesis-video-streams/README.md'
          - Model Serving on AWS BeanStalk EC2: 'docs/demos/aws/beanstalk-model-serving/README.md'
          - AWS Lambda Serverless Model Serving with DJL: 'docs/demos/aws/lambda-model-serving/README.md'
          - AWS EMR:
              - Distributed inference: 'docs/demos/aws/emr-distributed-inference/dataprocess/README.md'
              - GPU Image Classification: 'docs/demos/aws/emr-distributed-inference/image-classification-gpu/README.md'
          - AWS Inferentia: 'docs/demos/aws/inferentia/README.md'
      - Android:
          - Doodledraw (PyTorch): 'docs/demos/android/pytorch_android/quickdraw_recognition/README.md'
          - Style Transfer (PyTorch): 'docs/demos/android/pytorch_android/style_transfer_cyclegan/README.md'
          - Face Detection (PyTorch): 'docs/demos/android/pytorch_android/face_detection/README.md'
      - EcoSystem:
          - Java Integrations:
              - DJL Component in Apache Camel: 'docs/demos/camel-djl/README.md'
              - Run TensorFlow model on GraalVM: 'docs/demos/graalvm/README.md'
              - Apache Spark Image Classification: 'docs/demos/apache-spark/image-classification/README.md'
              - Apache Beam CTR Prediction: 'docs/demos/apache-beam/ctr-prediction/README.md'
              - Apache Flink:
                  - Sentiment Analysis: 'docs/demos/apache-flink/sentiment-analysis/README.md'
                  - Sentence Encoding: 'docs/demos/apache-flink/sentence_embedding/README.md'
              - Apache Kafka Twitter Sentiment Analysis: 'docs/demos/apache-kafka/README.md'
              - Quarkus:
                  - DJL Extension for Quarkus: 'docs/demos/quarkus/extension/README.md'
                  - Integration without the Extension: 'docs/demos/quarkus/example/README.md'
      - Applications:
          - Footwear Classification: 'docs/demos/footwear_classification/README.md'
          - Live Object Detection: 'docs/demos/live-object-detection/README.md'
          - Pneumonia Detection: 'docs/demos/pneumonia-detection/README.md'
          - MultiEngine on DJL: 'docs/demos/development/multi-engine/README.md'
          - Interactive JShell and Block Runner for DJL: 'docs/demos/web-demo/interactive-console/README.md'
          - Malicious URL Detection: 'docs/demos/malicious-url-detector/README.md'
      - Extensions:
          - Visualizing Training with DJL: 'docs/demos/visualization-vue/README.md'
          - Interactive JShell and Block Runner for DJL: 'docs/demos/web-demo/interactive-console/README.md'
