Skip to content
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.

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

📝 About section for Several Task page #432

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

rajaryan18
Copy link

Added about.md for Zero-shot-object-detection, text-to-3d and mask-generation. Also added use cases for them all.

Copy link
Contributor

@merveenoyan merveenoyan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for this PR! You can add your HF user handle to end of about.md.

Moreover, feel free to remove the empty files if you won't contribute content inside.

packages/tasks/src/tasks/mask-generation/about.md Outdated Show resolved Hide resolved
@@ -0,0 +1,7 @@
## About the Task

Mask Generation task involves generating masks/segments for objects in a given image. It could be zero shot or based on training data.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Mask Generation task involves generating masks/segments for objects in a given image. It could be zero shot or based on training data.
Mask generation task involves generating masks for meaningful segments in a given image. It could be zero-shot or based on training data.


## Use Cases

Mask Generation has promising use cases in Medical Imaging, Autonomous Vehicles, Robotics, etc.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this section we expect to have multiple headers for each use case.

@@ -0,0 +1,7 @@
## About the Task
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page is already contributed in another PR, so if you feel like contributing it, you can open PR to that branch as that one is more extensive

@@ -0,0 +1,7 @@
## About the Task

Text to 3D is a Generative task of generating a 3d image from a given text prompt. It is similar to generating a 2d image but involves an extended complexity of depth perception.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can add this in summary in data.ts

Suggested change
Text to 3D is a Generative task of generating a 3d image from a given text prompt. It is similar to generating a 2d image but involves an extended complexity of depth perception.
Text-to-3D is to generate a 3D image from a text prompt. It is similar to generating a 2D image but involves an extended complexity of depth perception.

@@ -0,0 +1,7 @@
## About the Task
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to add, we add this in summary


## Use Cases

Text to 3d has various creative and experimental use cases like setting up virtual experiments and simulations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment applies here

@rajaryan18
Copy link
Author

@merveenoyan
Hey, I have added the changes you suggested. Thank you so much for your time.

Copy link
Contributor

@merveenoyan merveenoyan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot!

@@ -2,7 +2,7 @@
"editor.defaultFormatter": "esbenp.prettier-vscode",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you remove this file altogether?


### Medical Imaging

Mask Generation is used in medical imaging in aiding in the segmentation and analysis of specific regions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Mask Generation is used in medical imaging in aiding in the segmentation and analysis of specific regions.
Mask generation models are used in medical imaging to aid in segmenting and analyzing specific regions.


### Autonomous Vehicles

Mask Generation is used to create segments and masks for obstacles and other objects in view.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Mask Generation is used to create segments and masks for obstacles and other objects in view.
Mask generation models are used to create segments and masks for obstacles and other objects in view.


Mask Generation is used to create segments and masks for obstacles and other objects in view.

This page was written by [Raj Aryan](https://huggingface.co/thatrajaryan)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This page was written by [Raj Aryan](https://huggingface.co/thatrajaryan)
This page was made possible thanks to the efforts of [Raj Aryan](https://huggingface.co/thatrajaryan).

],
demo: {
inputs: [

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you remove these gaps in the empty lists?

datasets: [
{
description: "3D-Future is a dataset designed to generate 3D images from textual descriptions.",
id: "3D-Future",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This dataset isn't on Hugging Face Hub, perhaps you can create the dataset? would be great apparently there's none on Hub and you'd be the first person to add such dataset!

spaces: [

],
summary:"Text-to-3D is to generate a 3D image from a text prompt. It is similar to generating a 2D image but involves an extended complexity of depth perception.",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
summary:"Text-to-3D is to generate a 3D image from a text prompt. It is similar to generating a 2D image but involves an extended complexity of depth perception.",
summary: "Text-to-3D is the task of generating a 3D image from a text prompt. It is similar to generating a 2D image with an extension of depth perception.",

@rajaryan18
Copy link
Author

@merveenoyan
Hey, I have made the changes.
Changed .vscode/setting.json back to its original content (from this repository).
Removed the dataset 3D-Future from data.ts. Will find it and add to the hub and then maybe modify this file again to mention it.

Copy link
Contributor

@merveenoyan merveenoyan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@@ -7,4 +7,4 @@
"[svelte]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there seems to be a change still (see diff), if you can revert this change as well we can merge

@rajaryan18
Copy link
Author

@merveenoyan
Hi again, I have changed that file. If it still crashes the checks, I'll just open a new PR and ensure to not commit any changes to .vscode folder.
Thank you

@merveenoyan
Copy link
Contributor

@rajaryan18 can you merge this PR into your branch? rajaryan18#1 this will lint your code so the tests pass

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants