Skip to content

Commit 1f49418

Browse files
Document interactive progress display in notebooks
1 parent fb89015 commit 1f49418

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed
33.6 KB
Loading
33.6 KB
Loading

workflows/progress.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,23 @@ Job(
136136
)
137137
```
138138

139+
### Progress Display in interactive environments
140+
141+
When running in an interactive environment such as a Jupyter notebook and the cell output is a Tilebox job object, the
142+
job is automatically rendered, including its progress indicators.
143+
144+
<CodeGroup>
145+
```python Python
146+
job = job_client.find(job_id)
147+
job # trigger notebook cell output
148+
```
149+
</CodeGroup>
150+
151+
<Frame>
152+
<img src="/assets/workflows/progress/progress-cell-output-light.png" alt="Tilebox Workflows job object as Jupyter Cell output" className="dark:hidden" />
153+
<img src="/assets/workflows/progress/progress-cell-output-dark.png" alt="Tilebox Workflows job object as Jupyter Cell output" className="hidden dark:block" />
154+
</Frame>
155+
139156
## Progress idempotency
140157

141158
Since tasks may fail and can subsequently be retried, it's possible that a task is executed more than once. This means that a task may report progress more than once.

0 commit comments

Comments
 (0)