You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/jobs.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,6 +47,11 @@ from which was the job submitted.
47
47
48
48
### Output of the job
49
49
50
+
!!! Warning
51
+
52
+
If you want to avoid creating many files, see the section about streaming
53
+
54
+
50
55
By default, each job will produce two files containing the standard output and standard error output, respectively.
51
56
52
57
The paths where these files will be created can be changed via the parameters ``--stdout=<path>`` and ``--stderr=<path>``.
@@ -111,6 +116,7 @@ Detailed information about a job:
111
116
112
117
You can also use `hq job last` to get information about the most recently submitted job.
113
118
119
+
114
120
## Task states
115
121
116
122
```
@@ -138,6 +144,31 @@ Finished Failed Canceled
138
144
**Canceled* - The task has been canceled by a user.
139
145
140
146
147
+
## Time limit
148
+
149
+
Time limit is set as follows:
150
+
151
+
``hq submit --time-limit=TIME ...``
152
+
153
+
Where ``TIME`` is a number followed by units (e.g. ``10 min``)
154
+
155
+
You can use the following units:
156
+
157
+
* msec, ms -- milliseconds
158
+
* seconds, second, sec, s
159
+
* minutes, minute, min, m
160
+
* hours, hour, hr, h
161
+
* days, day, d
162
+
* weeks, week, w
163
+
* months, month, M -- defined as 30.44 days
164
+
* years, year, y -- defined as 365.25 days
165
+
166
+
167
+
Time can be also a combination of more units:
168
+
169
+
``hq submit --time-limit="1h 30min" ...``
170
+
171
+
141
172
## Task instance
142
173
143
174
It may happen that a task is started more than once when a worker crashes during execution of a task and the task is rescheduled to another worker. Instance IDs exist to distinguish each run when necessary. Instance ID is 32b non-negative number and it is guarantted that the newer execution has a bigger value. HyperQueue explicitly does *not* guarantee any specific value or differences between two ids. Instance ID is valid only for a particular task. Two different tasks may have the same instance ID.
Copy file name to clipboardExpand all lines: docs/streaming.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,10 +70,13 @@ Disabling stderr and streaming only stdout into log file.
70
70
71
71
# Guarantees
72
72
73
-
When a task is *finished* or *failed*with a non-streaming error then it is guaranteed that its stream is fully flushed into the log file.
73
+
When a task is *finished* or *failed*(except fail of streaming, see below) then it is guaranteed that its stream is fully flushed into the log file.
74
74
75
-
When a task is *canceled* or *failed* with a streaming error, then the stream is not necessarily fully written into the log file in the moment when the state occurs
76
-
and some part may be written later, but the stream will be eventually closed. In this case, HQ is also allowed to drop any suffix of the buffered part of the stream.
75
+
When a task is *canceled* then the stream is not necessarily fully written into the log file in the moment when the state occurs and some parts may be written later, but the stream will be eventually closed.
76
+
77
+
When a task is *canceled* or the time limit is reached then part of the stream buffered in the worker is dropped to void spending additional resources for this task. In practice, this should be only part that is produced immediately before the event, because data are sent to the server as soon as possible.
78
+
79
+
If streaming failed (e.g. insufficient disk space for the log file) then task fails with an error prefixed "Streamer:" and no guarantees for streaming are provided.
0 commit comments