_pkgdown.yml

url: https://torch.mlverse.org/docs/
destination: docs
template:
  bootstrap: 5
  bslib:
    primary: "#7e1f77"
  params:
    ganalytics: G-9ZJSKW3L0N
    
development:
  mode: auto

navbar:
 bg: primary
 structure:
  left:  [home, articles, examples, advanced, reference, news]
  right: [github]
 components:
  articles:
    text: Articles
    menu:
     - text: Installation
       href: articles/installation.html
     - text: Tensors
     - text: Creating tensors
       href: articles/tensor-creation.html
     - text: Indexing
       href: articles/indexing.html
     - text: Tensor class
       href: articles/tensor/index.html
     - text: Serialization
       href: articles/serialization.html
     - text: Datasets
     - text: Loading Data
       href: articles/loading-data.html
     - text: Autograd
     - text: Using autograd
       href: articles/using-autograd.html
     - text: Extending autograd
       href: articles/extending-autograd.html
     - text: Python models
       href: articles/python-to-r.html
     - text: Jit Compilation
       href: articles/torchscript.html
  advanced:
    text: Advanced
    menu:
      - text: Memory management
        href: articles/memory-management.html
      - text: Building locally
        href: articles/modifying-source-code.html
      - text: Automatic Mixed Precision
        href: articles/amp.html
  examples:
    text: Examples
    menu:
      - text: basic-autograd
        href: articles/examples/basic-autograd.html
      - text: basic-nn-module
        href: articles/examples/basic-nn-module.html
      - text: dataset
        href: articles/examples/dataset.html    
   
reference:  
  - title: Tensor creation utilities
    contents: 
      - torch_empty
      - torch_arange
      - torch_eye
      - torch_full
      - torch_linspace
      - torch_logspace
      - torch_ones
      - torch_rand
      - torch_randint
      - torch_randn
      - torch_randperm
      - torch_zeros
      - matches("torch_.*_like")
      - as_array
      - torch_tensor_from_buffer
  - title: Tensor attributes
    contents:
      - has_concept("tensor-attributes")
      - is_torch_layout
      - is_torch_memory_format
      - is_torch_qscheme
      - is_undefined_tensor
  - title: Serialization
    contents:
      - has_concept("serialization")
      - clone_module
  - title: Mathematical operations on tensors
    contents:
      - starts_with("torch_")
      - -torch_empty
      - -torch_arange
      - -torch_eye
      - -torch_full
      - -torch_linspace
      - -torch_logspace
      - -torch_ones
      - -torch_rand
      - -torch_randint
      - -torch_randn
      - -torch_randperm
      - -torch_zeros
      - -matches("torch_.*_like")
      - -has_concept("tensor-attributes")
      - -has_concept("serialization")
      - broadcast_all
  - title: Neural network modules
    contents:
      - starts_with("nn_")
      - is_nn_module
      - is_nn_parameter
      - is_nn_buffer
  - title: Neural networks functional module
    contents:
      - starts_with("nnf_")
  - tile: Device managig
    contents:
      - torch_device
      - local_device
  - title: Optimizers
    contents:
      - optimizer
      - starts_with("optim_")
      - is_optimizer
  - title: Learning rate schedulers
    contents:
      - starts_with("lr_")
  - title: Datasets
    contents: 
      - starts_with("dataset")
      - iterable_dataset
      - starts_with("dataloader")
      - starts_with("enumerate")
      - tensor_dataset
      - is_dataloader
      - sampler
  - title: Distributions
    contents:
      - Distribution
      - starts_with("distr")
      - Constraint
  - title: Autograd
    contents:
      - starts_with("autograd_")
      - with_no_grad
      - with_enable_grad
      - with_detect_anomaly
      - AutogradContext
  - title: Mixed precision
    contents:
      - local_autocast
      - with_autocast
      - set_autocast
      - unset_autocast
      - starts_with("cuda_amp_")
  - title: Random numbers
    contents:
      - torch_manual_seed
      - with_torch_manual_seed
      - local_torch_manual_seed
      - torch_get_rng_state
      - torch_set_rng_state
      - cuda_get_rng_state
      - cuda_set_rng_state
  - title: Linear Algebra
    contents:
      - starts_with("linalg_")
  - title: Cuda utilities
    contents:
      - starts_with("cuda_")
  - title: JIT
    contents: 
      - starts_with("jit")
  - title: Backends
    contents:
      - starts_with("backends_")
  - title: Installation
    contents:
      - install_torch
      - starts_with("install_")
      - get_install_libs_url
  - title: Contrib
    contents:
      - contrib_sort_vertices