mkdocs.yml

site_name: Arrikto Academy
site_url: https://academy.arrikto.com

repo_name: arrikto/learn-kubeflow
repo_url: https://github.com/arrikto/learn-kubeflow
edit_uri: ""

plugins:
  - search
  - include-markdown

theme:
  name: material
  logo: assets/academy-logo.svg
  palette: 
    primary: black
    accent: arrikto
  features:
#    - content.tabs.link
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - search.suggest
#    - navigation.top

extra:
  analytics:
    provider: google
    property: UA-84825051-7
  social:
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/company/arrikto
    - icon: fontawesome/brands/twitter
      link: https://www.twitter.com/arrikto
    - icon: fontawesome/brands/youtube
      link: https://youtube.com/arrikto
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/arrikto


extra_javascript:
  - javascripts/bp.js

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.extra

nav:
  - Home: index.md
  - Kale 101:
      - Home: modules/notebook-to-pipeline/index.md
      - Introduction:
        - Course Overview: modules/notebook-to-pipeline/introduction.md
        - Notebook Walkthrough: modules/notebook-to-pipeline/working-example.md
        - Deploy MiniKF on GCP: modules/notebook-to-pipeline/minikf-gcp.md
        - Deploy a Notebook Server: modules/notebook-servers/notebook-server-base-image.md
        - Get Dataset and Code: modules/notebook-to-pipeline/upload-handouts.md
      - Pipeline Step Fundamentals:
        - Single-Cell Pipeline Steps: modules/notebook-to-pipeline/steps/single-cell.md
        - Multi-Cell Pipeline Steps: modules/notebook-to-pipeline/steps/multi-cell.md
        - Pipeline Step Dependencies: modules/notebook-to-pipeline/steps/dependencies.md
      - Working with Imports:
        - Gather Imports in One Cell: modules/notebook-to-pipeline/imports/why-organize-imports.md
        - Apply the Imports Annotation: modules/notebook-to-pipeline/imports/example.md
        - 'Lab: Imports': modules/notebook-to-pipeline/imports/lab-imports.md 
      - Excluding Cells from Pipelines: 
        - Skip Cells Not Used in a Step: modules/notebook-to-pipeline/exclude/skip-cells.md
        - 'Lab: Skip Cells': modules/notebook-to-pipeline/exclude/lab-skip-cells.md
        - Skip Sections Not Used: modules/notebook-to-pipeline/exclude/skip-sections.md
        - 'Lab: Skip Section': modules/notebook-to-pipeline/exclude/lab-skip-section.md
      - Kale Fundamentals Labs:
        - 'Lab: Create prep_data Step': modules/notebook-to-pipeline/fundamentals-labs/lab-prep_data.md
        - 'Lab: Create split_data Step': modules/notebook-to-pipeline/fundamentals-labs/lab-split_data.md
        - 'Checkpoint: Kale Fundamentals': modules/notebook-to-pipeline/checkpoint-fundamentals.md 
      - Pipeline Design:
        - Design for Iteration: modules/notebook-to-pipeline/pipeline-design/iteration.md
        - 'Lab: RF train and eval steps': modules/notebook-to-pipeline/pipeline-design/lab-rf-train-eval.md
        - 'Lab: XGB train and eval steps': modules/notebook-to-pipeline/pipeline-design/lab-xgb-train-eval.md
        - Functions Cells: modules/notebook-to-pipeline/pipeline-design/functions.cells.md
        - Steps w/ Multiple Dependencies: modules/notebook-to-pipeline/pipeline-design/steps-with-multiple-dependencies.md
        - 'Checkpoint: Pipeline Design': modules/notebook-to-pipeline/pipeline-design/checkpoint.md 
        - Run Our Pipeline: modules/notebook-to-pipeline/pipeline-design/run-our-pipeline.md
      - Lab Solutions:
        - 'Solution - Lab: Imports': modules/notebook-to-pipeline/imports/lab-imports-solution.md
        - 'Solution - Lab: Skip Cells': modules/notebook-to-pipeline/exclude/lab-skip-cells-solution.md
        - 'Solution - Lab: Create prep_data': modules/notebook-to-pipeline/fundamentals-labs/lab-prep_data-solution.md
        - 'Solution - Lab: Create split_data': modules/notebook-to-pipeline/fundamentals-labs/lab-split_data-solution.md
        - 'Solution - Lab: RF train and eval': modules/notebook-to-pipeline/pipeline-design/lab-rf-train-eval-solution.md
        - 'Solution - Lab: XGB train and eval': modules/notebook-to-pipeline/pipeline-design/lab-xgb-train-eval-solution.md
  - Katib 101:
      - Home: modules/notebook-katib-tuning/index.md
      - Introduction: 
        - Course Overview: modules/notebook-katib-tuning/katib-101-overview.md
        - Notebook Walkthrough: modules/notebook-to-pipeline/working-example.md
        - Deploy MiniKF on GCP: modules/deploy/minikf-gcp.md
        - Deploy a Notebook Server: modules/notebook-katib-tuning/notebook-server-base-image.md
        - Get Dataset and Code: modules/notebook-katib-tuning/upload-handouts.md
      - Hyperparameter Tuning: 
        - Hyperparameter Tuning Overview: modules/notebook-katib-tuning/hyperparameter-overview.md
        - Preparing Hyperparameter Tuning Ideal Model: modules/notebook-katib-tuning/preparing-hyperparameter-tuning.md
        - 'Lab: Identify Ideal Model': modules/notebook-katib-tuning/labs/lab-identify-model.md
        - Preparing Hyperparameter Tuning Hyperparameters & Objectives: modules/notebook-katib-tuning/preparing-hyperparameter-tuning-parttwo.md
        - 'Lab: Hyperparameter Tuning Preparation': modules/notebook-katib-tuning/labs/lab-tuning-preparation.md
      - Katib Experiments:
        - Katib Job: modules/notebook-katib-tuning/katib-job.md
        - 'Lab: Set Up Katib Job': modules/notebook-katib-tuning/labs/lab-set-up-katib-job.md
        - Katib Output: modules/notebook-katib-tuning/katib-output.md
        - 'Lab: Interpret Katib Output': modules/notebook-katib-tuning/labs/lab-interpret-katib-output.md
      - Next Steps:
        - Next Steps: modules/notebook-katib-tuning/katib-tuning-next-steps.md
  - Rok 101: 
      - Home: modules/rok-snapshotting/index.md
      - Introduction: 
        - Course Overview: modules/rok-snapshotting/rok-101-overview.md
        - Notebook Walkthrough: modules/notebook-to-pipeline/working-example.md
        - Deploy MiniKF on GCP: modules/deploy/minikf-gcp.md
        - Deploy a Notebook Server: modules/rok-snapshotting/notebook-server-base-image.md
        - Get Dataset and Code: modules/rok-snapshotting/upload-handouts.md
      - Rok Basics:
        - Rok Overview: modules/rok-snapshotting/rok-overview.md
        - Rok Cluster Overview: modules/rok-snapshotting/rok-cluster-overview.md
        - Rok Snapshot Basics: modules/rok-snapshotting/rok-snapshot-basics.md
        - 'Lab: Initial Volume Mounts': modules/rok-snapshotting/labs/lab-initial-volume-mounts.md
        - Rok Bucket Basics: modules/rok-snapshotting/rok-bucket-basics.md
      - Snapshot Restoration:
        - Rok Snapshot Restoration: modules/rok-snapshotting/rok-snapshot-restoration.md
        - 'Lab: Rok Snapshot Restoration': modules/rok-snapshotting/labs/lab-rok-snapshot-restoration.md 
        - 'Lab: Snapshot Volume Resotration': modules/rok-snapshotting/labs/lab-snapshot-volume-restoration.md 
        - 'Lab: Pipeline Step Restoration': modules/rok-snapshotting/labs/lab-step-snapshot-restoration.md 
  - MiniKF FAQ: modules/minikf-faq.md
  - License Agreement: modules/license-agreement.md