Skip to content

Document interactive progress display in notebooks #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 19, 2025
Merged

Document interactive progress display in notebooks #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/workflows/progress/progress-cell-output-dark.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/workflows/progress/progress-cell-output-light.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions workflows/progress.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,23 @@ Job(
)
```

### Progress Display in interactive environments

When running in an interactive environment such as a Jupyter notebook and the cell output is a Tilebox job object, the
job is automatically rendered, including its progress indicators.

<CodeGroup>
```python Python
job = job_client.find(job_id)
job # trigger notebook cell output
```
</CodeGroup>

<Frame>
<img src="/assets/workflows/progress/progress-cell-output-light.png" alt="Tilebox Workflows job object as Jupyter Cell output" className="dark:hidden" />
<img src="/assets/workflows/progress/progress-cell-output-dark.png" alt="Tilebox Workflows job object as Jupyter Cell output" className="hidden dark:block" />
</Frame>

## Progress idempotency

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.
Expand Down