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

Would be very helpful to have a box for free hand text for each task #5580

Closed
GeorgePearse opened this issue Jan 12, 2023 · 8 comments · Fixed by #6191
Closed

Would be very helpful to have a box for free hand text for each task #5580

GeorgePearse opened this issue Jan 12, 2023 · 8 comments · Fixed by #6191
Labels
enhancement New feature or request

Comments

@GeorgePearse
Copy link

GeorgePearse commented Jan 12, 2023

My actions before raising this issue

Searched for other similar feature requests.

Expected Behaviour

A box underneath where the labels are define on the task view which enables you to add free text comments.

Context

Every day I autolabel all of the available data from the previous day but sometimes there's some caveat or problem, e.g. some camera feed was broken or lighting was very bad or similar. CVAT would be the best place for me to record this, with whatever frames were available and a quick comment stating why that data shouldn't be used in training or similar. I've even considered storing this information as a png and sending that as workaround.

@bsekachev
Copy link
Member

Hi @GeorgePearse

I see the requirement, but not sure about use case is clear.
If the frame is broken (camera issues, lighting), you can remove it. Did you know about this feature?
image

@GeorgePearse
Copy link
Author

GeorgePearse commented Jan 12, 2023

Yes but the ideal scenario for me is that the frames remain there, almost like documentation of the problem. So that another Engineer can view and understand it, but maybe I'm torturing the desired use of CVAT.

Just feels like a relatively simple feature that would add quite a lot of flexibility.

@bsekachev
Copy link
Member

"the frames remain there", actually, they stay. Just marked as deleted.

You can always toogle showing removed frames:
image

Another option with text is leaving an issue (but available only in review mode):
image
image

@GeorgePearse
Copy link
Author

GeorgePearse commented Jan 12, 2023

Other use cases:

  • Adding small task specific instructions for labellers (or adding a link to instructions, or link to anything)
  • Adding a description of that dataset, e.g. particularly dark

Flexible metadata is incredibly valuable.

@bsekachev
Copy link
Member

bsekachev commented Jan 17, 2023

For the latest two use-cases you provided, Issue tracker field exists for tasks and projects

image

It can be a link to google docs for example with any specification. Integration of something like markdown specification into CVAT is also solution, but even if we start implementing it, it will take some time.

So, I just suggested a quick solution.

@bsekachev
Copy link
Member

Related #3680

@bsekachev
Copy link
Member

Related #287

@SpecLad SpecLad added the enhancement New feature or request label Mar 24, 2023
@GeorgePearse
Copy link
Author

Hey @bsekachev would you open to a PR to implement markdown rendering below the list of classes? (along with the API change to enable it to be written to a task)

bsekachev added a commit that referenced this issue Jun 23, 2023
<!-- Raise an issue to propose your change
(https://github.com/opencv/cvat/issues).
It helps to avoid duplication of efforts from multiple independent
contributors.
Discuss your ideas with maintainers to be sure that changes will be
approved and merged.
Read the [Contribution
guide](https://opencv.github.io/cvat/docs/contributing/). -->

<!-- Provide a general summary of your changes in the Title above -->

### Motivation and context
<img width="1130" alt="image"
src="https://github.com/opencv/cvat/assets/40690378/3c1b767d-2aa2-474b-af1e-1fc02d8c359d">
<img width="1133" alt="image"
src="https://github.com/opencv/cvat/assets/40690378/fdf6115a-e88d-4da6-83fb-c9fddd871e49">
<img width="1920" alt="image"
src="https://github.com/opencv/cvat/assets/40690378/f6e97db5-84cb-4c1e-9b2a-82eca633a79c">

Resolved #287
Resolved #3680
Resolved #5580

### How has this been tested?
<!-- Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc. -->

### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply.
If an item isn't applicable for some reason, then ~~explicitly
strikethrough~~ the whole
line. If you don't do that, GitHub will show incorrect progress for the
pull request.
If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [x] I submit my changes into the `develop` branch
- [x] I have added a description of my changes into the
[CHANGELOG](https://github.com/opencv/cvat/blob/develop/CHANGELOG.md)
file
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [x] I have linked related issues (see [GitHub docs](

https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
- [x] I have increased versions of npm packages if it is necessary

([cvat-canvas](https://github.com/opencv/cvat/tree/develop/cvat-canvas#versioning),

[cvat-core](https://github.com/opencv/cvat/tree/develop/cvat-core#versioning),

[cvat-data](https://github.com/opencv/cvat/tree/develop/cvat-data#versioning)
and

[cvat-ui](https://github.com/opencv/cvat/tree/develop/cvat-ui#versioning))

### License

- [x] I submit _my code changes_ under the same [MIT License](
https://github.com/opencv/cvat/blob/develop/LICENSE) that covers the
project.
  Feel free to contact the maintainers if that's a concern.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants