batchtools/_pkgdown.yml at main · mlr-org/batchtools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
url: https://batchtools.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, news, articles, book]
    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/
    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/

reference:
  - title: Overview
    contents:
      - batchtools
  - title: Registry
    contents:
      - Registry
      - ExperimentRegistry
      - assertRegistry
      - loadRegistry
      - saveRegistry
      - syncRegistry
      - sweepRegistry
      - removeRegistry
      - getDefaultRegistry
  - title: Define Jobs
    contents:
      - batchMap
      - batchReduce
      - batchMapResults
      - Problem
      - Algorithm
      - addExperiments
  - title: Submit Jobs
    contents:
      - submitJobs
      - batchExport
      - waitForJobs
      - chunk
      - lpt
      - binpack
      - setJobNames
  - title: Query Job Information
    contents:
      - getStatus
      - findJobs
      - getJobPars
      - summarizeExperiments
  - title: Retrieve Results
    contents:
      - reduceResults
      - reduceResultsDataTable
      - loadResult
      - unwrap
  - title: Debugging
    contents:
      - resetJobs
      - testJob
      - getLog
      - getErrorMessages
      - grepLogs
  - title: Remove Jobs
    contents:
      - killJobs
      - clearRegistry
      - removeExperiments
  - title: Additional objects
    contents:
      - Job
      - Experiment
      - JobCollection
  - title: Cluster Functions
    contents:
      - cfKillJob
      - cfBrewTemplate
      - cfReadBrewTemplate
      - cfHandleUnknownSubmitError
      - ClusterFunctions
      - starts_with("makeCluster")
      - SubmitJobResult
      - Hook
      - Worker
  - title: Miscellaneous
    contents:
      - Tags
      - btlapply
      - JoinTables
      - runOSCommand
      - execJob
      - doJobCollection
      - estimateRuntimes