Skip to content

Fix Example 1 documentation: pipeline() returns numpy array, not dict #456

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
Tao-Yida wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Fix Example 1 documentation: pipeline() returns numpy array, not dict #456

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
6 changes: 5 additions & 1 deletion doc/source/example_usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ To use the default pipeline which contains all available augmentations and sensi

image = cv2.imread("image.png")

data = pipeline(image)
# 1. Returns numpy array directly
augmented = pipeline(image)

# 2. Explicitly request dictionary
data = pipeline.augment(image, return_dict=1)

augmented = data["output"]

Expand Down
Loading