Skip to content

Commit 7cd57d7

Browse files
beckykdjyu00
andauthored
Update session max TTL (#3110)
@jyu00 noticed that when I updated the batch max TTL, I needed to also update the session max TTL. --------- Co-authored-by: Jessie Yu <[email protected]>
1 parent ae60a0c commit 7cd57d7

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

docs/guides/run-jobs-batch.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ There is also an interactive time to live (interactive TTL) value that cannot be
6565

6666
Default maximum TTL values:
6767

68-
| Instance type | Default Maximum TTL |
68+
| Instance type | Default maximum TTL |
6969
|----------------|---------------------|
7070
| All paid plans | 8 hours |
7171
| Open | 10 minutes |

docs/guides/run-jobs-session.mdx

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ with Session(backend=backend):
8282
<span id="specify-length"></span>
8383
## Session length
8484

85-
The maximum session time to live (TTL) determines how long a session can run. You can set this value with the `max_time` parameter. This should exceed the longest job's execution time.
85+
The session maximum time to live (TTL) determines how long a session can run. You can set this value with the `max_time` parameter. This should exceed the longest job's execution time.
8686

8787
This timer starts when the session starts. When the value is reached, the session is closed. Any jobs that are running will finish, but jobs still queued are failed.
8888

@@ -97,30 +97,32 @@ with Session(backend=backend, max_time="25m"):
9797
...
9898
```
9999

100-
There is also an interactive time to live (interactive TTL) value that cannot be configured. If no session jobs are queued within that window, the session is temporarily deactivated.
100+
There is also an interactive time to live (interactive TTL) value that cannot be configured (1 minute for all plans). If no session jobs are queued within that window, the session is temporarily deactivated.
101101

102102
Default values:
103103
<LegacyContent>
104-
| Instance type (Open or Premium Plan) | Interactive TTL | Maximum TTL |
105-
| --- | --- | --- |
106-
| Premium Plan | 60 sec* | 8 h* |
107-
| Open Plan | sessions run in job mode | sessions run in job mode |
104+
| Instance type (Open or Premium Plan) | Maximum TTL |
105+
| --- | --- |
106+
| Premium Plan | 8 h* |
107+
| Open Plan | sessions run in job mode |
108108
</LegacyContent>
109109
<CloudContent>
110-
| Instance type (Open or Premium Plan) | Interactive TTL | Maximum TTL |
111-
| --- | --- | --- |
112-
| Premium Plan | 60 sec* | 8 h* |
110+
111+
| Plan type | Default maximum TTL |
112+
|----------------|---------------------|
113+
| All paid plans | 8 hours |
114+
| Open | 10 minutes |
113115
</CloudContent>
114116
*\* Certain Premium Plan instances might be configured to have a different value.*
115117

116-
To determine a session's max TTL or interactive TTL, follow the instructions in [Determine session details](#session-details) and look for the `max_time`or `interactive_timeout` value, respectively.
118+
To determine a session's maximum TTL or interactive TTL, follow the instructions in [Determine session details](#session-details) and look for the `max_time`or `interactive_timeout` value, respectively.
117119

118120
<span id="ends"></span>
119121
## End a session
120122

121123
A session ends in the following circumstances:
122124

123-
* The maximum timeout (TTL) value is reached, resulting in the cancellation of all queued jobs.
125+
* The maximum TTL value is reached, resulting in the cancellation of all queued jobs.
124126
* The session is manually canceled, resulting in the cancellation of all queued jobs.
125127
* The session is manually closed. The session stops accepting new jobs but continues to run queued jobs with priority.
126128
* If you use Session as a context manager, that is, `with Session()`, the session is automatically closed when the context ends (the same behavior as using `session.close()`).

0 commit comments

Comments
 (0)