Skip to content

docs: explain better docstring of set_image_normalization#585

Merged
JoanFM merged 6 commits intomainfrom
docs-513
Oct 4, 2022
Merged

docs: explain better docstring of set_image_normalization#585
JoanFM merged 6 commits intomainfrom
docs-513

Conversation

@JoanFM
Copy link
Copy Markdown
Member

@JoanFM JoanFM commented Oct 3, 2022

Goals:
Fix problems described in #513 , clarify in docstring proper usage of set_image_normalization with respect to the axis and the shapes of the tensors

@JoanFM JoanFM changed the title docs: explain better docstring docs: explain better docstring of set_image_normalization Oct 3, 2022
@JoanFM JoanFM requested a review from JohannesMessner October 3, 2022 14:24
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 3, 2022

Codecov Report

Merging #585 (556ef6b) into main (47d73ba) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #585   +/-   ##
=======================================
  Coverage   84.92%   84.92%           
=======================================
  Files         133      133           
  Lines        6708     6708           
=======================================
  Hits         5697     5697           
  Misses       1011     1011           
Flag Coverage Δ
docarray 84.92% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
docarray/document/mixins/image.py 59.76% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Joan Fontanals and others added 2 commits October 4, 2022 10:13
# Conflicts:
#	docarray/document/mixins/image.py
@JohannesMessner JohannesMessner enabled auto-merge (squash) October 4, 2022 08:59
@JoanFM JoanFM disabled auto-merge October 4, 2022 09:47
@JoanFM JoanFM merged commit 25c9783 into main Oct 4, 2022
@JoanFM JoanFM deleted the docs-513 branch October 4, 2022 09:47
@JoanFM JoanFM linked an issue Oct 4, 2022 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

set_image_tensor_normalization does not behave as documented

3 participants