Skip to content

docs: add migration guide for upgrading from v1 to v2 #76

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

zeke merged 17 commits into next from dp-684-write-a-migration-guide-for-users-upgrading-from-v1-to-v2

Oct 10, 2025

+637 −0

Merged

docs: add migration guide for upgrading from v1 to v2 #76

Changes from 1 commit

Commits

Show all changes

Select commit Hold shift + click to select a range

docs: add migration guide for upgrading from v1 to v2

zeke Oct 1, 2025

docs: remove unnecessary implementation detail about Prefer headers

zeke Oct 1, 2025

docs: clarify "resource methods" terminology in migration guide

zeke Oct 1, 2025

docs: add section links to migration checklist

zeke Oct 1, 2025

docs: clarify auto-pagination behavior in v2

zeke Oct 1, 2025

docs: add wait example for trainings to mirror v1

zeke Oct 1, 2025

docs: clarify file upload supports file handles without reading into ...

zeke Oct 1, 2025

docs: correct async support in use() interface - v1 also had it

zeke Oct 1, 2025

docs: add documentation reference for APIResponse object

zeke Oct 1, 2025

fix upgrading note about creating predictions

zeke Oct 1, 2025

remove unrelated comment about models.list()

zeke Oct 1, 2025

docs: update streaming section to show replicate.use() with streaming...

zeke Oct 10, 2025

update client section of upgrade guide

zeke Oct 10, 2025

docs: use anthropic/claude-4.5-sonnet in streaming examples

zeke Oct 10, 2025

Update UPGRADING.md

zeke Oct 10, 2025

Update UPGRADING.md

zeke Oct 10, 2025

Update UPGRADING.md

zeke Oct 10, 2025

File filter

Filter by extension

Conversations

Jump to

Jump to file

Failed to load files.

Loading

Diff view

Diff view

docs: correct async support in use() interface - v1 also had it

Loading branch information

zeke committed Oct 1, 2025

commit 5f53bd6ef999318c3065dbbb8ac162b1538e9784

Some comments aren't visible on the classic Files Changed page.

8 changes: 6 additions & 2 deletions UPGRADING.md

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -542,13 +542,17 @@ The validation logic is identical; only import paths may differ.

		## Experimental use() interface

	The experimental `use()` interface is available in both versions with similar functionality. V2 adds async support.
	The experimental `use()` interface is available in both versions with similar functionality.

		### Before (v1)

		```python
		flux = replicate.use("black-forest-labs/flux-schnell")
		outputs = flux(prompt="astronaut on a horse")

	# Async support
	async_flux = replicate.use("black-forest-labs/flux-schnell")
	outputs = await async_flux(prompt="astronaut on a horse")
		```

		### After (v2)
Expand All		@@ -558,7 +562,7 @@ outputs = flux(prompt="astronaut on a horse")
		flux = replicate.use("black-forest-labs/flux-schnell")
		outputs = flux(prompt="astronaut on a horse")

	# NEW: Async support
	# Async support (uses use_async parameter)
		async_flux = replicate.use("black-forest-labs/flux-schnell", use_async=True)
		outputs = await async_flux(prompt="astronaut on a horse")
		```
Expand Down