_pkgdown.yml

url: https://mlr3torch.mlr-org.com

template:
  bootstrap: 5
  light-switch: true
  math-rendering: mathjax
  package: mlr3pkgdowntemplate

development:
  mode: auto
  version_label: default
  version_tooltip: "Version"

toc:
  depth: 3

navbar:
  structure:
    left:  [reference, tutorials, overview, book, news]
    right: [search, github, mattermost, stackoverflow, rss, lightswitch]
  components:
    home: ~
    reference:
      icon: fa fa-file-alt
      text: Reference
      href: reference/index.html
    mattermost:
      icon: fa fa-comments
      href: https://lmmisld-lmu-stats-slds.srv.mwn.de/mlr_invite/
    github:
      icon: fa fa-github
      href: https://github.com/mlr-org/mlr3torch
    book:
      text: mlr3book
      icon: fa fa-link
      href: https://mlr3book.mlr-org.com
    stackoverflow:
      icon: fab fa-stack-overflow
      href: https://stackoverflow.com/questions/tagged/mlr3
    rss:
      icon: fa-rss
      href: https://mlr-org.com/

    overview:
      text: Overview
      menu:
      - text: Tasks
        href: articles/task_list.html
      - text: Preprocessing & Augmentation
        href: articles/preprocessing_list.html
      - text: Optimizers
        href: articles/optimizer_list.html
      - text: Losses
        href: articles/loss_list.html
      - text: Callbacks
        href: articles/callback_list.html
      - text: Learners
        href: articles/learner_list.html
      - text: Network Layers
        href: articles/layer_list.html

    tutorials:
      text: Articles
      menu:
      - text: Tutorials
      - text: Get Started
        href: articles/get_started.html
      - text: Defining an Architecture
        href: articles/pipeop_torch.html
      - text: Callbacks
        href: articles/callbacks.html
      - text: Non-Tabular Data
        href: articles/lazy_tensor.html
      - text: ---
      - text: Internals
      - text: Networks as Graphs
        href: articles/internals_pipeop_torch.html


reference:
  - title: Package
    contents:
      - mlr3torch-package
  - title: Learners
    contents:
      - starts_with("mlr_learners")
  - title: Tasks
    contents:
      - starts_with("mlr_tasks")
      - mlr_backends_lazy
  - title: Network Building Blocks
    contents:
      - ModelDescriptor
      - starts_with("model_descriptor")
      - mlr_pipeops_module
      - TorchIngressToken
      - mlr_pipeops_torch
      - mlr_pipeops_torch_ingress
      - starts_with("mlr_pipeops_torch_model")
      - starts_with("pipeop_torch_ingress")
      - starts_with("batchgetter")
      - starts_with("mlr_pipeops_torch_ingress")
      - mlr_pipeops_torch_loss
      - mlr_pipeops_torch_optimizer
      - mlr_pipeops_torch_callbacks
  - title: Network Layers
    contents:
      - starts_with("mlr_pipeops_nn")
  - title: Preprocessing & Augmentation
    contents:
      - mlr_pipeops_preproc_torch
      - pipeop_preproc_torch
      - starts_with("PipeOpPreprocTorch")
  - title: NN Modules
    contents:
      - starts_with("nn")
  - title: Lazy Tensor
    contents:
      - lazy_tensor
      - DataDescriptor
      - as_lazy_tensor
      - as_data_descriptor
      - assert_lazy_tensor
      - is_lazy_tensor
      - materialize
  - title: Loss
    contents:
      - t_loss
      - TorchLoss
      - mlr_pipeops_torch_loss
      - as_torch_loss
      - mlr3torch_losses
  - title: Optimizer
    contents:
      - t_opt
      - TorchLoss
      - mlr_pipeops_torch_optimizer
      - as_torch_optimizer
      - mlr3torch_optimizers
  - title: Callbacks
    contents:
      - callback_set
      - torch_callback
      - t_clbk
      - starts_with("Torch")
      - starts_with("mlr_callback_set")
      - TorchCallback
      - CallbackSet
      - as_torch_callback
      - as_torch_callbacks
      - mlr_pipeops_torch_callbacks
      - mlr3torch_callbacks
      - mlr_context_torch
      - as_lr_scheduler
  - title: Helper
    contents:
      - TorchDescriptor
      - auto_device
      - task_dataset
      - Select