_pkgdown.yml

url: https://mlverse.github.io/tfevents/
template:
  bootstrap: 5

reference:
  - title: Event logging
    desc: >
      Functions directly related to event logging.
    contents:
      - log_event
      - as_event
      - set_global_step
      - set_default_logdir
      - with_logdir
      - local_logdir
  - title: Summaries
    desc: >
      Types of events that can be logged
    contents:
      - starts_with("summary_")
      - -contains("hparams")
  - title: HParams
    desc: >
      Related to logging hyperparameters
    contents:
      contains("hparams")
  - title: Reading
    desc: >
      Related to reading tfevents record files
    contents:
      - starts_with("collect")
      - starts_with("iter")
      - value

articles:
  - title: Guides
    navbar: Guides
    contents:
      - articles/images
      - articles/hparams
      - articles/read
  - title: Examples
    navbar: Examples
    contents:
      - examples/torch