-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_pkgdown.yml
152 lines (133 loc) · 3.4 KB
/
_pkgdown.yml
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
url: https://mrc-ide.github.io/hipercow
template:
bootstrap: 5
articles:
- title: General
navbar: General
contents:
- hipercow
- packages
- parallel
- troubleshooting
- title: Details
navbar: Details
contents:
- details
- environments
- stan
- INLA
- title: Clusters
navbar: Clusters
contents:
- windows
- title: Advanced topics
navbar: Advanced topics
contents:
- workers
- administration
- migration
reference:
- title: Get started
desc: >-
Probably the order you'll work through when starting a new
hipercow project; create a new root, configure it, test that it
works, and provision any packages you need.
contents:
- hipercow_init
- hipercow_configure
- hipercow_configuration
- hipercow_hello
- hipercow_unconfigure
- title: Install packages
desc: >-
Your cluster tasks will most likely need some packages, and you
need to install them into a library.
contents:
- hipercow_provision
- hipercow_provision_list
- hipercow_provision_check
- hipercow_provision_compare
- title: Tasks
desc: >-
Create and interact with tasks.
- subtitle: Creation
contents:
- task_create_explicit
- task_create_expr
- task_create_call
- task_create_script
- task_create_bulk_expr
- task_create_bulk_call
- subtitle: Cluster resources and parallelism
contents:
- hipercow_resources
- hipercow_resources_validate
- hipercow_parallel
- hipercow_parallel_get_cores
- hipercow_parallel_set_cores
- subtitle: Interaction
contents:
- task_status
- task_result
- task_wait
- task_retry
- task_info
- task_cancel
- task_list
- subtitle: Logs
contents:
- task_log_show
- task_log_value
- task_log_watch
- title: Bundles of tasks
desc: >-
Bundles allow you to group related tasks together
contents:
- hipercow_bundle_create
- hipercow_bundle_load
- hipercow_bundle_list
- hipercow_bundle_delete
- subtitle: Interact with task bundles
desc: >-
These functions all have `task_` analogues
contents:
- hipercow_bundle_status
- hipercow_bundle_result
- hipercow_bundle_wait
- hipercow_bundle_retry
- hipercow_bundle_cancel
- hipercow_bundle_log_value
- title: Environments
desc: >-
Environments are the collections of packages and functions that
we construct on a cluster machine and evaluate your tasks
within. These functions let you create, update and delete these
environments.
contents:
- starts_with("hipercow_environment")
- title: Windows support
desc: >-
Functions for use with the windows cluster
contents:
- starts_with("windows_")
- title: Workers
desc: >-
Use rrq-based workers for faster queues and advanced workflows
contents:
- hipercow_rrq_controller
- hipercow_rrq_workers_submit
- hipercow_rrq_stop_workers_once_idle
- title: Utilities
desc: >-
Helpful functions
contents:
- hipercow_envvars
- hipercow_cluster_info
- hipercow_purge
- title: Advanced
desc: >-
Just leave it alone.
contents:
- hipercow_driver
- task_eval
- task_submit