Allow setting sketch color default #4979

aliabid94 · 2023-07-20T06:13:42Z

Set brush_color via gr.Image(brush_color="#FF0000").

Looks like this:

vercel · 2023-07-20T06:13:46Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
gradio	✅ Ready (Inspect)	Visit Preview	Jul 25, 2023 6:32pm

gradio-pr-bot · 2023-07-20T06:16:21Z

All the demos for this PR have been deployed at https://huggingface.co/spaces/gradio-pr-deploys/pr-4979-all-demos

You can install the changes in this PR by running:

pip install https://gradio-builds.s3.amazonaws.com/3f8c210b01ef1ceaaf8ee73be4bf246b5b745bbf/gradio-3.38.0-py3-none-any.whl

gradio-pr-bot · 2023-07-21T18:51:54Z

🎉 Chromatic build completed!

There are 0 visual changes to review.
There are 0 failed tests to fix.

gradio-pr-bot · 2023-07-21T18:52:14Z

🦄 change detected

This Pull Request includes changes to the following packages.

Package	Version
`@gradio/app`	`minor`
`@gradio/image`	`minor`
`gradio`	`minor`

Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

Allow setting sketch color default

Maintainers or the PR author can modify the PR title to modify this entry.

Something isn't right?

Maintainers can change the version label to modify the version bump.
If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

gradio/components/image.py

freddyaboulton · 2023-07-24T19:24:29Z

gradio/components/image.py

@@ -276,6 +282,10 @@ def preprocess(

        if self.tool == "sketch" and self.source in ["upload", "webcam"]:
            mask_im = processing_utils.decode_base64_to_image(mask)
+
+            if mask_im.mode == "RGBA":  # whiten any opaque pixels in the mask


I don't follow this. Can you explain what's happening?

yep, so previously in the frontend, whenever a user drew a mask, we were drawing it twice - once on the visible layer directly on the image, and then again on a hidden layer called "mask", which instead drew with a white brush on a black background. This mask layer was what was getting sent to the backend on submit.
I simplified the frontend so that there is a single mask layer, now visible, that hovers over the drawing. A user is no longer drawing directly on the image, but instead on this visible mask layer. On submit, we send this mask layer. However, this mask layer is no longer the white on black image of before - it has opacity and may be whatever color that brush_color has been set to. So now we convert this mask layer into the B+W mask of before in the backend with these lines of code.
We support "backwards compatibility" in case someone uses a client, with if mask_im.mode == "RGBA": , because previously masks were only RGB.
cc @pngwn for context to the frontend changes

Are we certain that this conversion is always accurate (going from colours to b+w, especially since the sketches are antialiased)? Masks are typically alpha layers and lack any colours, I'm curious about why we would ever want a mask layer with colour.

The mask layer only has color because that's how that canvas is rendered now, as a color on a transparent background. I assumed the antialiasing would manifest in the alpha, as in the smooth edges would have an alpha between 0 and 255, which would get translated to some gray between 0 and 255 in the backend logic where we take the alpha value and set it as the R, G, and B values. Will confirm if this antialiasing works.

Confirmed that antialiasing still works - there are values between 0 and 255 at the edges of the mask

…gradio into sketch_color_default

dawoodkhan82 · 2023-07-24T19:45:26Z

Tested and looks good! Should we eventually also make the alpha of the brush settable?

gradio/components/image.py

aliabid94 · 2023-07-24T23:40:07Z

Tested and looks good! Should we eventually also make the alpha of the brush settable?

I don't think there's a need for this. We can see if we get any requests.

pngwn

Looks go to me! tested and everything seems to work great! Thanks for tackling this one @aliabid94! Maybe you love the Image component as much as I do now.

abidlabs · 2023-07-25T15:45:39Z

Should we eventually also make the alpha of the brush settable?

Sorry for the late reply, but I agree with @dawoodkhan82 on this. We're making a breaking UI change with no way to for users to restore the original behavior. I would add a brush_opacity parameter (default can be 0.7 as in this PR)

aliabid94 · 2023-07-25T16:44:18Z

Sorry for the late reply, but I agree with @dawoodkhan82 on this. We're making a breaking UI change with no way to for users to restore the original behavior

Disagree - there's slight opacity to a mask, which makes it easier to use. We are just going to have argument bloat if we add a configurable argument just for every minor UI change we've made.

abidlabs · 2023-07-25T17:03:55Z

I agree that for most use cases that come to mind, setting the mask opacity to 0.7 is a good thing. However, with hundreds of thousands of gradio apps, there's a good chance that someone is using the mask in a different way than we imagine and wants the mask to be fully opaque. Upgrading gradio would break their demo without offering them a way to fix it. We've seen this problem several times already (changing the chatbot bubbles, making "enter" submit an Interface, etc.). I really think providing arguments to ensure backwards compatibility outweighs the concern of argument bloat.

aliabid94 · 2023-07-25T17:22:16Z

ok done, added mask_opacity

changes

274c57c

vercel bot deployed to Preview July 20, 2023 06:14 View deployment

Merge branch 'main' into sketch_color_default

45d5cd7

add changeset

a3e62c8

vercel bot deployed to Preview July 21, 2023 18:53 View deployment

changes

e069b28

vercel bot deployed to Preview July 24, 2023 12:52 View deployment

aliabid94 marked this pull request as ready for review July 24, 2023 12:55

changes

d9ead21

vercel bot deployed to Preview July 24, 2023 13:22 View deployment

changes

5348f1d

vercel bot deployed to Preview July 24, 2023 13:25 View deployment

aliabid94 requested review from pngwn and dawoodkhan82 July 24, 2023 17:34

changes

feaa22b

vercel bot deployed to Preview July 24, 2023 19:15 View deployment

Merge branch 'main' into sketch_color_default

354c110

vercel bot deployed to Preview July 24, 2023 19:18 View deployment

freddyaboulton reviewed Jul 24, 2023

View reviewed changes

aliabid94 added 2 commits July 24, 2023 12:28

changes

8c3a5f6

Merge branch 'sketch_color_default' of https://github.com/gradio-app/…

a7ec405

…gradio into sketch_color_default

vercel bot deployed to Preview July 24, 2023 19:29 View deployment

dawoodkhan82 approved these changes Jul 24, 2023

View reviewed changes

gradio/components/image.py Outdated Show resolved Hide resolved

changes

bd5bee7

vercel bot deployed to Preview July 24, 2023 21:38 View deployment

changes

6529197

vercel bot deployed to Preview July 24, 2023 23:39 View deployment

pngwn approved these changes Jul 25, 2023

View reviewed changes

changes

ad53f33

vercel bot deployed to Preview July 25, 2023 17:22 View deployment

changes

06e8f61

vercel bot deployed to Preview July 25, 2023 18:32 View deployment

aliabid94 merged commit 44ac8ad into main Jul 25, 2023
12 checks passed

aliabid94 deleted the sketch_color_default branch July 25, 2023 18:39

pngwn mentioned this pull request Jul 25, 2023

chore: update versions #4999

Merged

abidlabs mentioned this pull request Jul 25, 2023

Add a "viewable" opacity slider/setting to allow better viewing of the content under the Image sketch mask #3281

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow setting sketch color default #4979

Allow setting sketch color default #4979

aliabid94 commented Jul 20, 2023 •

edited

vercel bot commented Jul 20, 2023 •

edited

gradio-pr-bot commented Jul 20, 2023 •

edited

gradio-pr-bot commented Jul 21, 2023 •

edited

gradio-pr-bot commented Jul 21, 2023 •

edited

Something isn't right?

freddyaboulton Jul 24, 2023

aliabid94 Jul 24, 2023 •

edited

pngwn Jul 25, 2023

aliabid94 Jul 25, 2023

aliabid94 Jul 25, 2023

dawoodkhan82 commented Jul 24, 2023

aliabid94 commented Jul 24, 2023

pngwn left a comment

abidlabs commented Jul 25, 2023

aliabid94 commented Jul 25, 2023

abidlabs commented Jul 25, 2023

aliabid94 commented Jul 25, 2023

Allow setting sketch color default #4979

Allow setting sketch color default #4979

Conversation

aliabid94 commented Jul 20, 2023 • edited

vercel bot commented Jul 20, 2023 • edited

gradio-pr-bot commented Jul 20, 2023 • edited

gradio-pr-bot commented Jul 21, 2023 • edited

gradio-pr-bot commented Jul 21, 2023 • edited

🦄 change detected

This Pull Request includes changes to the following packages.

With the following changelog entry.

Something isn't right?

freddyaboulton Jul 24, 2023

Choose a reason for hiding this comment

aliabid94 Jul 24, 2023 • edited

Choose a reason for hiding this comment

pngwn Jul 25, 2023

Choose a reason for hiding this comment

aliabid94 Jul 25, 2023

Choose a reason for hiding this comment

aliabid94 Jul 25, 2023

Choose a reason for hiding this comment

dawoodkhan82 commented Jul 24, 2023

aliabid94 commented Jul 24, 2023

pngwn left a comment

Choose a reason for hiding this comment

abidlabs commented Jul 25, 2023

aliabid94 commented Jul 25, 2023

abidlabs commented Jul 25, 2023

aliabid94 commented Jul 25, 2023

aliabid94 commented Jul 20, 2023 •

edited

vercel bot commented Jul 20, 2023 •

edited

gradio-pr-bot commented Jul 20, 2023 •

edited

gradio-pr-bot commented Jul 21, 2023 •

edited

gradio-pr-bot commented Jul 21, 2023 •

edited

aliabid94 Jul 24, 2023 •

edited