Mask Generation Task Guide #28897

merveenoyan · 2024-02-06T14:47:01Z

Added mask generation task guide.

HuggingFaceDocBuilderDev · 2024-02-06T17:32:10Z

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com>

docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com>

MKhalusova

Great work, @merveenoyan ! Left some suggestions.

MKhalusova · 2024-02-06T18:42:50Z

docs/source/en/tasks/mask_generation.md

+on labeled datasets and are limited to the classes they have seen during training; they return a set of masks and corresponding classes, 
+given an image. 
+
+Mask generation models are trained on large amounts of data, and they operate in two modes. The first one is prompting 


Large amounts of unlabeled data?

the model is actually manually labeled with masks, semi-automatic labeled, and fully automatically labeled, however the label here doesn't imply class masks like fully supervised image segmentation. will try to put this properly

MKhalusova · 2024-02-06T18:44:23Z

docs/source/en/tasks/mask_generation.md

+given an image. 
+
+Mask generation models are trained on large amounts of data, and they operate in two modes. The first one is prompting 
+mode. In this mode, the model takes in an image and a prompt, where a prompt can be a point location in the image within 


Is a point location an XY coordinate of a pixel or something else?

yes it is, will clarify

MKhalusova · 2024-02-06T18:47:28Z

docs/source/en/tasks/mask_generation.md

+on labeled datasets and are limited to the classes they have seen during training; they return a set of masks and corresponding classes, 
+given an image. 
+
+Mask generation models are trained on large amounts of data, and they operate in two modes. The first one is prompting 


You can make this a list. E.g.:

"Mask generation models are trained on large amounts of data, and they operate in two modes: * Prompting mode: the model takes in....

Segment everything mode: ...."

docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <kafooster@gmail.com>

merveenoyan · 2024-02-06T19:50:40Z

@MKhalusova thanks, I addressed your comments I think

MKhalusova

Thanks for addressing the feedback, LGTM!

MKhalusova · 2024-02-07T17:58:09Z

@ArthurZucker please take a look. the guide LGTM

docs/source/en/tasks/mask_generation.md

khipp · 2024-02-09T00:25:29Z

I hope feedback from the community is welcome. Nice work! 🤗

ArthurZucker

Thanks for the nice documentation!

docs/source/en/tasks/mask_generation.md

Co-authored-by: Arthur <48595927+ArthurZucker@users.noreply.github.com>

Co-authored-by: Klaus Hipp <khipp@users.noreply.github.com>

Co-authored-by: Arthur <48595927+ArthurZucker@users.noreply.github.com>

docs/source/en/tasks/mask_generation.md

merveenoyan · 2024-02-14T15:03:47Z

@ArthurZucker can you merge this if it's ok?

docs/source/en/tasks/mask_generation.md

amyeroberts · 2024-02-14T18:29:44Z

@merveenoyan I can merge. Thanks for adding this!

* Create mask_generation.md * add h1 * add to toctree * Update docs/source/en/tasks/mask_generation.md Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com> * Update mask_generation.md * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Maria Khalusova <kafooster@gmail.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Maria Khalusova <kafooster@gmail.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Maria Khalusova <kafooster@gmail.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Maria Khalusova <kafooster@gmail.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Maria Khalusova <kafooster@gmail.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Maria Khalusova <kafooster@gmail.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Maria Khalusova <kafooster@gmail.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Maria Khalusova <kafooster@gmail.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Maria Khalusova <kafooster@gmail.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Maria Khalusova <kafooster@gmail.com> * Update mask_generation.md * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Arthur <48595927+ArthurZucker@users.noreply.github.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Klaus Hipp <khipp@users.noreply.github.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Klaus Hipp <khipp@users.noreply.github.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Klaus Hipp <khipp@users.noreply.github.com> * Update docs/source/en/tasks/mask_generation.md Co-authored-by: Arthur <48595927+ArthurZucker@users.noreply.github.com> * Update docs/source/en/tasks/mask_generation.md * Update mask_generation.md * Update mask_generation.md --------- Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com> Co-authored-by: Maria Khalusova <kafooster@gmail.com> Co-authored-by: Arthur <48595927+ArthurZucker@users.noreply.github.com> Co-authored-by: Klaus Hipp <khipp@users.noreply.github.com>

Create mask_generation.md

f4038ab

merveenoyan requested review from MKhalusova and NielsRogge February 6, 2024 14:47

merveenoyan added 2 commits February 6, 2024 17:47

add h1

f53df34

add to toctree

fd08eac

NielsRogge reviewed Feb 6, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

NielsRogge reviewed Feb 6, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

merveenoyan and others added 2 commits February 6, 2024 21:26

Update docs/source/en/tasks/mask_generation.md

400cf83

Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com>

Update docs/source/en/tasks/mask_generation.md

ce4cb70

Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com>

NielsRogge reviewed Feb 6, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

NielsRogge reviewed Feb 6, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

NielsRogge reviewed Feb 6, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

NielsRogge reviewed Feb 6, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

merveenoyan and others added 4 commits February 6, 2024 21:46

Update docs/source/en/tasks/mask_generation.md

e51419c

Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com>

Update docs/source/en/tasks/mask_generation.md

5398634

Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com>

Update docs/source/en/tasks/mask_generation.md

cf0ae7f

Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com>

Update mask_generation.md

67119e0

MKhalusova reviewed Feb 6, 2024

View reviewed changes

merveenoyan and others added 11 commits February 6, 2024 22:22

Update docs/source/en/tasks/mask_generation.md

d04c329

Co-authored-by: Maria Khalusova <kafooster@gmail.com>

Update docs/source/en/tasks/mask_generation.md

7701add

Co-authored-by: Maria Khalusova <kafooster@gmail.com>

Update docs/source/en/tasks/mask_generation.md

5ad8826

Co-authored-by: Maria Khalusova <kafooster@gmail.com>

Update docs/source/en/tasks/mask_generation.md

dafb06e

Co-authored-by: Maria Khalusova <kafooster@gmail.com>

Update docs/source/en/tasks/mask_generation.md

a3bf800

Co-authored-by: Maria Khalusova <kafooster@gmail.com>

Update docs/source/en/tasks/mask_generation.md

268f07d

Co-authored-by: Maria Khalusova <kafooster@gmail.com>

Update docs/source/en/tasks/mask_generation.md

da0ceae

Co-authored-by: Maria Khalusova <kafooster@gmail.com>

Update docs/source/en/tasks/mask_generation.md

25371f0

Co-authored-by: Maria Khalusova <kafooster@gmail.com>

Update docs/source/en/tasks/mask_generation.md

40700ee

Co-authored-by: Maria Khalusova <kafooster@gmail.com>

Update docs/source/en/tasks/mask_generation.md

08766d9

Co-authored-by: Maria Khalusova <kafooster@gmail.com>

Update mask_generation.md

6d50404

MKhalusova approved these changes Feb 7, 2024

View reviewed changes

ArthurZucker self-requested a review February 8, 2024 02:32

khipp reviewed Feb 9, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Show resolved Hide resolved

khipp reviewed Feb 9, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

khipp reviewed Feb 9, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

khipp reviewed Feb 9, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

khipp reviewed Feb 9, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

ArthurZucker approved these changes Feb 12, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

merveenoyan and others added 5 commits February 12, 2024 13:59

Update docs/source/en/tasks/mask_generation.md

e34c085

Co-authored-by: Arthur <48595927+ArthurZucker@users.noreply.github.com>

Update docs/source/en/tasks/mask_generation.md

32d4b33

Co-authored-by: Klaus Hipp <khipp@users.noreply.github.com>

Update docs/source/en/tasks/mask_generation.md

714e6b2

Co-authored-by: Klaus Hipp <khipp@users.noreply.github.com>

Update docs/source/en/tasks/mask_generation.md

62820d7

Co-authored-by: Klaus Hipp <khipp@users.noreply.github.com>

Update docs/source/en/tasks/mask_generation.md

a63e64c

Co-authored-by: Arthur <48595927+ArthurZucker@users.noreply.github.com>

merveenoyan commented Feb 14, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

Update docs/source/en/tasks/mask_generation.md

a21ad56

merveenoyan commented Feb 14, 2024

View reviewed changes

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved

merveenoyan added 2 commits February 14, 2024 19:16

Update mask_generation.md

1eb7acb

Update mask_generation.md

9379452

amyeroberts merged commit 3f4e79d into huggingface:main Feb 14, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mask Generation Task Guide #28897

Mask Generation Task Guide #28897

merveenoyan commented Feb 6, 2024

HuggingFaceDocBuilderDev commented Feb 6, 2024

MKhalusova left a comment

MKhalusova Feb 6, 2024

merveenoyan Feb 6, 2024

MKhalusova Feb 6, 2024

merveenoyan Feb 6, 2024

MKhalusova Feb 6, 2024

merveenoyan commented Feb 6, 2024

MKhalusova left a comment

MKhalusova commented Feb 7, 2024

khipp commented Feb 9, 2024

ArthurZucker left a comment

merveenoyan commented Feb 14, 2024

amyeroberts commented Feb 14, 2024

Mask Generation Task Guide #28897

Mask Generation Task Guide #28897

Conversation

merveenoyan commented Feb 6, 2024

HuggingFaceDocBuilderDev commented Feb 6, 2024

MKhalusova left a comment

Choose a reason for hiding this comment

MKhalusova Feb 6, 2024

Choose a reason for hiding this comment

merveenoyan Feb 6, 2024

Choose a reason for hiding this comment

MKhalusova Feb 6, 2024

Choose a reason for hiding this comment

merveenoyan Feb 6, 2024

Choose a reason for hiding this comment

MKhalusova Feb 6, 2024

Choose a reason for hiding this comment

merveenoyan commented Feb 6, 2024

MKhalusova left a comment

Choose a reason for hiding this comment

MKhalusova commented Feb 7, 2024

khipp commented Feb 9, 2024

ArthurZucker left a comment

Choose a reason for hiding this comment

merveenoyan commented Feb 14, 2024

amyeroberts commented Feb 14, 2024