mkdocs.yml

site_name: PyTorch Tabular
nav:
    - Getting Started:
          - Introduction: "index.md"
          - Installation: "gs_installation.md"
          - Usage: "gs_usage.md"
          - Citing the project: "gs_cite.md"
    - Tutorials:
          - Approaching any Tabular Problem using PyTorch Tabular: "tutorials/01-Approaching Any Tabular Problem with PyTorch Tabular.ipynb"
          - Exploring Advanced Features with PyTorch Tabular: "tutorials/02-Exploring Advanced Features with PyTorch Tabular.ipynb"
          - Using Model Sweep as an initial Model Selection Tool: "tutorials/13-Using Model Sweep as an initial Model Selection Tool.ipynb"
    - "How-to Guides":
          - Experiment Tracking:
                - Weights and Biases: "tutorials/05-Experiment_Tracking_using_WandB.ipynb"
                - Tensorboard: "tutorials/05.1-Experiment_Tracking_using_Tensorboard.ipynb"
          - Hyperparameter Tuning:
                - Grid Search and Random Search: "tutorials/10-Hyperparameter Tuning.ipynb"
                - Search Best Architecture and Hyperparameter: "tutorials/15-Search Best Architecture and Hyperparameter.ipynb"
          - Cross Validation and Other Modelling Tricks:
                - Cross Validation: "tutorials/09-Cross Validation.ipynb"
                - Bagged Predictions: "tutorials/12-Bagged Predictions.ipynb"
                - Test Time Augmentation (Experimental): "tutorials/11-Test Time Augmentation.ipynb"
          - Explainability / Interpretability:
                - SHAP, Deep LIFT and so on through Captum Integration: "tutorials/14-Explainability.ipynb"
          - Custom PyTorch Models:
                - Implementing New Supervised Architectures: "tutorials/04-Implementing New Architectures.ipynb"
          - Model Stacking: "tutorials/16-Model Stacking.ipynb"
          - Other Features:
                - Using Neural Categorical Embeddings in Scikit-Learn Workflows: "tutorials/03-Neural Embedding in Scikit-Learn Workflows.ipynb"
                - Self-Supervised Learning using Denoising Autoencoders: "tutorials/08-Self-Supervised Learning-DAE.ipynb"
                - Probabilistic Regression using Mixture Density Networks: "tutorials/07-Probabilistic Regression with MDN.ipynb"
          - Others:
                - Imbalanced classification: "tutorials/06-Imbalanced Classification.ipynb"
    - Concepts:
          - Configuration:
                - Data: data.md
                - Training: training.md
                - Optimizer and Learning Rate Scheduler: optimizer.md
                - Experiment Tracking: experiment_tracking.md
          - Models:
                - Supervised Models: models.md
                - Self-Supervised Models: ssl_models.md
          - Tabular Model:
                - TabularModel: tabular_model.md
          - Explainability/Interpretablity:
                - Explainability/Interpretablity: explainability.md
          - Other Features:
                - "Other Features": other_features.md
    # - FAQ: faq.md
    # - API:
    - API:
          - Core Classes: apidocs_coreclasses.md
          - Configuration Classes: apidocs_config.md
          - Supervised Models: apidocs_model.md
          - Self-Supervised Models: apidocs_ssl.md
          - Heads: apidocs_head.md
          - Common Modules: apidocs_common.md
          - Utilities: apidocs_utils.md
    - Contributions:
          - Contributing: contributing.md
    # - Credits and History:
    # - Authors: authors.md
    - History: history.md
theme:
    name: material
    features:
        - search.suggest
        - navigation.tabs
        - navigation.tabs.sticky
        # - toc.integrate
        - navigation.top
        - content.code.copy
    palette:
        #   # Palette toggle for automatic mode
        #   - media: "(prefers-color-scheme)"
        #     toggle:
        #     icon: material/brightness-auto
        #     name: Switch to light mode

        # Palette toggle for light mode
        - media: "(prefers-color-scheme: light)"
          scheme: default
          primary: deep purple
          toggle:
              icon: material/brightness-7
              name: Switch to dark mode

        # Palette toggle for dark mode
        - media: "(prefers-color-scheme: dark)"
          scheme: slate
          primary: yellow
          toggle:
              icon: material/brightness-4
              name: Switch to light mode
        # primary: deep purple
    logo: imgs/pytorch_tabular_logo_small.svg
    font:
        text: Lato
markdown_extensions:
    - admonition
    - pymdownx.highlight:
          anchor_linenums: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - pymdownx.superfences
    - toc:
          permalink: true
    # - pymdownx.inlinehilite
plugins:
    - search
    - mknotebooks
    - mkdocstrings:
          handlers:
              python:
                  paths: [src] # search packages in the src folder
                  rendering:
                      show_root_heading: yes
                      merge_init_into_class: yes
                      docstring_section_style: spacy
repo_url: https://github.com/manujosephv/pytorch_tabular
extra:
    social:
        - icon: fontawesome/brands/linkedin
          link: https://www.linkedin.com/in/manujosephv/
        - icon: fontawesome/brands/twitter
          link: https://twitter.com/manujosephv
        - icon: fontawesome/solid/blog
          link: https://deep-and-shallow.com/
        - icon: fontawesome/brands/medium
          link: https://medium.com/@manujosephv
    version:
        provider: mike
copyright: Copyright © 2020 Manu Joseph