mkdocs.ubuntu.yml

# mkdocs.yml
site_name: "Time Series with Deep Learning Quick Bite"
site_author: "Lei Ma"
site_description: "Time Series with Deep Learning Quick Bite"
site_url: "https://emptymalei.github.io/deep-learning"
repo_url: "https://github.com/emptymalei/deep-learning"
edit_uri: "blob/main/deep-learning/"
repo_name: "emptymalei/machine-learning"
docs_dir: "dl"


theme:
  name: "material"
  custom_dir: theme/overrides
  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  features:
    # - navigation.instant
    - navigation.sections
    - navigation.tabs
  palette:
    - scheme: default
      primary: black
      accent: deep orange
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/logo_badge.svg
  logo: assets/logo_badge.svg



markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.magiclink
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: "¶"
  - footnotes
  - pymdownx.details


extra_javascript:
  - assets/js/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js




plugins:
  - autorefs
  - git-authors
  - search
  - tags:
      tags_file: tags.md
  - bibtex:
      bib_dir: "dl/assets/references"
  - mkdocs-jupyter:
      include_source: true
      execute: false
  - with-pdf:
      author: "Lei Ma"
      output_path: pdf/dl-lm.pdf
      cover_logo: assets/logo_badge.svg
      cover_subtitle: "Time Series with Deep Learning Quick Bite"
      two_columns_level: 3
      enabled_if_env: ENABLE_PDF_EXPORT
      render_js: true
      headless_chrome_path: "google-chrome"


extra:
  analytics:
    provider: google
    property: G-9XN0RGHSE1
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://github.com/emptymalei/deep-learning/issues" target="_blank" rel="noopener">GitHub Issues or Discussions</a>.
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/emptymalei/deep-learning
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/leima137/



nav:
  - "Home": index.md
  - "Coding Tips":
    - engineering/index.md
    - "Python": engineering/python.md
  - "Time Series Forecasting Fundamentals":
    - time-series/index.md
    - "Data":
      - "Time Series Data Analysis": time-series/timeseries-data.analysis.md
      - "Augmentation": time-series/timeseries-data.data-augmentation.md
      - "DTW": time-series/timeseries-data.dtw.md
      - "DBA": time-series/timeseries-data.dtw-barycenter-averaging.md
      - "Time Delayed Embedding": time-series/timeseries-data.time-delayed-embedding.md
    - "Data Generating Process":
      - "DGP": time-series/timeseries-datasets.dgp.md
      - "DGP: Langevin Equation": time-series/timeseries-datasets.dgp.langevin.md
    - "Kindergarten Models":
      - "Statistical Models": time-series/timeseries-basics.statistical-models.md
      - "AR": "time-series/timeseries-basics.ar.md"
      - "VAR": time-series/timeseries-basics.var.md
    - Synthetic Datasets:
      - "Synthetic Time Series": time-series/timeseries-synthetic.md
      - "Creating Synthetic Dataset": time-series/timeseries-datasets.synthetic.md
    - "Forecasting":
      - "Naive Forecasts": time-series/timeseries-forecast.naive.md
    - "Metrics":
      - "Time Series Forecasting Metrics": time-series/timeseries-metrics.forecasting.md
      - "CRPS": time-series/timeseries-metrics.forecasting.crps.md
    - "Hierarchical Time Series":
      - "Hierarchical Time Series Data": time-series/timeseries-hierarchical.data.md
      - "Hierarchical Time Series Reconciliation": time-series/timeseries-hierarchical.reconciliation.md
    - Useful Datasets:
      - time-series/timeseries-datasets.md
      - "Exchange Rate": time-series/timeseries-datasets.ecb-exchange-rate.md
      - "NREL Solar Power Data": time-series/timeseries-datasets.nrel-solar-energy.md
      - "Electricity": time-series/timeseries-datasets.uci-electricity.md
      - "PeMS Traffic Data": time-series/timeseries-datasets.pems.md
  - "Deep Learning Fundamentals":
    - "Deep Learning Introduction": deep-learning-fundamentals/index.md
    - "Energy-based Models":
      - "Introduction": energy-based-models/intro.md
      - "Diffusion Models": energy-based-models/ebm.diffusion.md
    - "Generative":
      - "Introduction": self-supervised/generative/intro.md
      - "Autoregressive": self-supervised/generative/autoregressive.md
      - "AE": self-supervised/generative/ae.md
      - "VAE": self-supervised/generative/vae.md
      - "Flow": self-supervised/generative/flow.md
      - "MADE": self-supervised/generative/made.md
      - "MAF": self-supervised/generative/maf.md
    - "Contrastive":
      - "Introduction": self-supervised/contrastive/intro.md
      - "Deep Infomax": self-supervised/contrastive/deep-infomax.md
      - "Contrastive Predictive Coding": self-supervised/contrastive/contrastive-predictive-coding.md
    - "Adversarial":
      - "Introduction": self-supervised/adversarial/intro.md
      - "GAN": self-supervised/adversarial/gan.md
      - "f-GAN": self-supervised/adversarial/f-gan.md
      - "InfoGAN": self-supervised/adversarial/infogan.md
  - "Tree":
    - "Tree-based Models": trees/tree.basics.md
  - "Time Series Forecasting with Deep Learning":
    - "Introduction": "time-series-deep-learning/index.md"
    - "TimeGrad": time-series-deep-learning/timeseries.deep-learning.timegrad.md
  - "Supplementary":
    - "About Supplementary Materials": supplementary.md
    - "Notebooks":
      - "Tree Basics": notebooks/tree_basics.py
    - "Small Yet Powerful Concepts":
      - concepts/index.md
      - "Entropy": concepts/entropy.md
      - "Mutual Information": concepts/mutual-information.md
      - "KL Divergence": concepts/kl-divergence.md
      - "f-divergence": concepts/f-divergence.md
      - "ELBO": concepts/elbo.md
      - "Alignment and Uniformity": concepts/alignment-and-uniformity.md
      - "Gini Impurity": concepts/gini-impurity.md
  - "About":
    - "Roadmap": meta/roadmap.md
    - "Changelog": meta/changelog.md