Skip to content

docs: clarify scan_history page_size default and unsampled behavior #2743

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify scan_history page_size default and unsampled behavior #2743

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
2 changes: 1 addition & 1 deletion models/track/public-api-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ losses = [row["loss"] for row in history]

### Get paginated data from history

If metrics are being fetched slowly on our backend or API requests are timing out, you can try lowering the page size in `scan_history` so that individual requests don't time out. The default page size is 500, so you can experiment with different sizes to see what works best:
`scan_history` returns the complete, unsampled history for a run (unlike `run.history()`, which returns a sampled view). If metrics are being fetched slowly on our backend or API requests are timing out, you can try lowering the page size in `scan_history` so that individual requests don't time out. The `page_size` parameter controls how many history records are fetched per API request (default: `1000`). It is independent of the `keys` parameter, which filters which metrics are returned. You can experiment with different sizes to see what works best:

```python
import wandb
Expand Down
Loading