mkdocs.yml

site_name: bokbokbok doks

repo_url: https://github.com/orchardbirds/bokbokbok/
site_url: https://orchardbirds.github.io/bokbokbok/
site_description: Implementing Custom Loss Functions and Eval Metrics in LightGBM and XGBoost
site_author: Daniel Timbrell

use_directory_urls: false

nav:
  - Home: index.md
  - Getting started:
    - getting_started/install.md
  - How To:
      - Use Weighted Cross Entropy: tutorials/weighted_cross_entropy.ipynb
      - Use Weighted Focal Loss: tutorials/focal_loss.ipynb
      - Use F1 Score: tutorials/F1_score.ipynb
      - Use Log Cosh Score: tutorials/log_cosh_loss.ipynb
      - Use Root Mean Squared Percentage Error: tutorials/RMSPE.ipynb
      - Use Quadratic Weighted Kappa: tutorials/quadratic_weighted_kappa.ipynb
  - Derivations:
      - A Note About Gradients in Classification Problems: derivations/note.md
      - Weighted Cross Entropy: derivations/wce.md
      - Focal Loss: derivations/focal.md
      - Log Cosh Error: derivations/log_cosh.md
  - Reference:
    - Evaluation Metrics:
      - bokbokbok.eval_metrics.binary_classification: reference/eval_metrics_binary.md
      - bokbokbok.eval_metrics.multiclass_classification: reference/eval_metrics_multiclass.md
      - bokbokbok.eval_metrics.regression: reference/eval_metrics_regression.md
    - Loss Functions:
      - bokbokbok.loss_functions.classification: reference/loss_functions_classification.md
      - bokbokbok.loss_functions.regression: reference/loss_functions_regression.md

plugins:
  - mkdocstrings:
      handlers:
          python:
            selection:
              inherited_members: true
              filters:
                - "!^Base"
                - "!^_"  # exlude all members starting with _
                - "^__init__$"  # but always include __init__ modules and methods
            rendering:
              show_root_toc_entry: false
      watch:
        - bokbokbok
  - search
  - mknotebooks:
      enable_default_jupyter_cell_styling: true
      enable_default_pandas_dataframe_styling: true

copyright: Copyright © 2020

theme:
  name: material
  logo: img/bokbokbok.png
  favicon: img/bokbokbok.png
  font:
    text: Ubuntu
    code: Ubuntu Mono
  features:
    - navigation.tabs
  palette:
    scheme: default
    primary: teal
    accent: yellow


markdown_extensions:
  - codehilite
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed
  - pymdownx.snippets
  - pymdownx.highlight:
      use_pygments: true
  - toc:
      permalink: true