mkdocs.yml

site_name: AI Engineering Academy
site_url: https://aiengineering.academy
repo_url: https://github.com/adithya-s-k/AI-Engineering.academy
repo_name: adithya-s-k/AI-Engineering.academy
edit_uri: edit/main/docs/

docs_dir: .
site_dir: ../site

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  palette:
    scheme: slate
    primary: teal
    accent: deep purple
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  icon:
    repo: fontawesome/brands/github
  custom_dir: assets/overrides

plugins:
  - search
  - same-dir
  - exclude:
      glob:
        - archives/**
  - mkdocs-jupyter:
      include_source: true
      ignore_h1_titles: true
      execute: false
      allow_errors: true
      ignore_patterns:
        - "archives/*"
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_source: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.mark
  - attr_list

nav:
  - Home: README.md
  - Prompt Engineering:
      - Introduciton: PromptEngineering/README.md
      - Understanding OpenAI API: PromptEngineering/Understanding_OpenAI_API.md
      - Basic Prompt Engineering: PromptEngineering/Basic_Prompting.md
      - Advance Prompt Engineering: PromptEngineering/Advanced_Prompting.md
      - Prompting Hands On: PromptEngineering/prompt_engineering.ipynb
      - Function Calling: PromptEngineering/function_calling.ipynb
      - Hands on with Adv Prompting: PromptEngineering/hand_on_with_advanced_prompt_engineering.md
  - RAG:
      - Introduction: RAG/README.md
      - Embedding and Similarity:
          - Introduction: RAG/00_RAG_from_Scratch/Understanding_embeddings_and_similarity.ipynb
      - RAG Techniques:
          - RAG from Scratch:
              - Overview: RAG/00_RAG_from_Scratch/README.md
              - Implementation: RAG/00_RAG_from_Scratch/RAG_in_10_lines.ipynb
          - Basic RAG:
              - Overview: RAG/01_Basic_RAG/README.md
              - Implementation: RAG/01_Basic_RAG/notebook.ipynb
              - Evaluation: RAG/01_Basic_RAG/notebook_eval.ipynb
          - BM25 RAG:
              - Overview: RAG/01_BM25_RAG/README.md
              - Implementation: RAG/01_BM25_RAG/notebook.ipynb
          - Data Ingestion:
              - Data Chunking: RAG/01_Data_Ingestion/data_chunking.ipynb
              - Data Embedding: RAG/01_Data_Ingestion/data_embedding.ipynb
              - Data Ingestion: RAG/01_Data_Ingestion/data_ingestion.ipynb
          - RAG Evaluation:
              - Overview: RAG/01_RAG_Evaluation/README.md
              - RAGAS: RAG/01_RAG_Evaluation/RAGAS.ipynb
              - DeepEval: RAG/01_RAG_Evaluation/deepeval.ipynb
              - TruLens: RAG/01_RAG_Evaluation/trulens.ipynb
              - Notebook: RAG/01_RAG_Evaluation/notebook.ipynb
          - RAG Observability:
              - Overview: RAG/01_RAG_Observability/README.md
              - Implementation: RAG/01_RAG_Observability/notebook.ipynb
          - ReRanker RAG:
              - Implementation: RAG/02_ReRanker_RAG/notebook.ipynb
              - Evaluation: RAG/02_ReRanker_RAG/notebook_eval.ipynb
          - Hybrid RAG:
              - Qdrant Hybrid Search: RAG/03_Hybrid_RAG/_Qdrant_Hybrid_Search.ipynb
              - Implementation: RAG/03_Hybrid_RAG/qdrant_hybrid.ipynb
          - Sentence Window RAG:
              - Implementation: RAG/04_Sentence_Window_RAG/Sentence_window_retrieval.ipynb
          - Auto Merging RAG:
              - Implementation: RAG/05_Auto_Merging_RAG/Auto-merging_Retrieval.ipynb
          - HyDE RAG:
              - Implementation: RAG/06_HyDE_RAG/HyDEQueryTransformDemo.ipynb
          - Query Transformation RAG:
              - Implementation: RAG/06_Query_Transformation_RAG/query_transform_cookbook.ipynb
          - Self Query RAG:
              - Implementation: RAG/07_Self_Query_RAG/Self_Query_RAG.ipynb
          - RAG Fusion:
              - Implementation: RAG/08_RAG_Fusion/ragfusion.ipynb
          - RAPTOR:
              - Implementation: RAG/09_RAPTOR/raptor.ipynb
          - ColBERT RAG:
              - Implementation: RAG/10_ColBERT_RAG/ColBert_RAG.ipynb
              - Ragatouille Retriever: RAG/10_ColBERT_RAG/ragatouille_retriever.ipynb
          - Graph RAG:
              - Implementation: RAG/11_Graph_RAG/GraphRAG_v1.ipynb
          - Agentic RAG:
              - Implementation: RAG/12_Agnetic_RAG/multi_document_agents.ipynb
          - Vision RAG:
              - Implementation: RAG/13_Vision_RAG/gpt4v_multi_modal_retrieval.ipynb
  - LLM:
      - Introduction: LLM/README.md
      - LLM:
          - Gemma:
              - Overview: LLM/Gemma/README.md
              - Implementation: LLM/Gemma/Gemma_finetuning_notebook.ipynb
          - Llama2:
              - Overview: LLM/LLama2/README.md
              - Implementation: LLM/LLama2/Llama2_finetuning_notebook.ipynb
              - QLora: LLM/LLama2/Llama_2_Fine_Tuning_using_QLora.ipynb
          - Llama3: LLM/Llama3_finetuning_notebook.ipynb
          - Mistral:
              - Overview: LLM/Mistral-7b/README.md
              - Implementation: LLM/Mistral-7b/Mistral_finetuning_notebook.ipynb
              - Evaluation: LLM/Mistral-7b/LLM_evaluation_harness_for_Arc_Easy_and_SST.ipynb
              - DPO Fine-tuning: LLM/Mistral-7b/notebooks_DPO_fine_tuning.ipynb
              - SFT Trainer: LLM/Mistral-7b/notebooks_SFTTrainer TRL.ipynb
              - ChatML Inference: LLM/Mistral-7b/notebooks_chatml_inference.ipynb
          - Mixtral: LLM/Mixtral/Mixtral_fine_tuning.ipynb
      - VLM:
          - Florence2: LLM/VLM/Florence2_finetuning_notebook.ipynb
          - PaliGemma: LLM/VLM/PaliGemma_finetuning_notebook.ipynb
      - LLM Architecture:
          - Parameter Count: LLM/LLMArchitecture/ParameterCount/README.md
  - Deployment:
      - Introduction: Deployment/README.md
      - Deploy LLM:
          - Overview: Deployment/DeployLLM/README.md
      - Quantization:
          - AWQ: Deployment/Quantization/AWQ_Quantization.ipynb
          - GGUF: Deployment/Quantization/GGUF_Quantization.ipynb
  - Agents:
      - Overview: Agents/README.md
      - Patterns:
          - Reflection Pattern: Agents/patterns/reflection_pattern.ipynb
          - Tool Pattern: Agents/patterns/tool_pattern.ipynb
          - Planning Pattern: Agents/patterns/planning_pattern.ipynb
          - Multi-Agent Pattern: Agents/patterns/multiagent_pattern.ipynb
      - Projects:
          - Multi-Document Agents: Agents/projects/multi_document_agents.ipynb
  - Projects:
      - Introduction: Projects/README.md
      - YouTube Clones:
          - Overview: Projects/YT_Clones/README.md
          - Fireship Clone: Projects/YT_Clones/Fireship_clone.ipynb
          - Dataset Preparation: Projects/YT_Clones/dataset_prep.ipynb
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/adithya-s-k/AI-Engineering.academy
    - icon: fontawesome/brands/twitter
      link: https://x.com/adithya_s_k
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY

copyright: "© 2024 AI Engineering Academy. All rights reserved."

extra_javascript:
  - https://unpkg.com/mermaid@8.11.2/dist/mermaid.min.js

extra_css:
  - css/extra.css