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.

Sign up for GitHub

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

Jump to bottom

CLI Format Documentation #1545

Closed
1dmesh opened this issue Jun 24, 2024 · 2 comments
Closed

CLI Format Documentation #1545

1dmesh opened this issue Jun 24, 2024 · 2 comments
Assignees
@vinnamkim
Labels
user experience Questions about our products or things to improve user experience

Comments

@1dmesh
Copy link

1dmesh commented Jun 24, 2024

For anyone struggling to use the CLI to export a project into a format, you can see your supported formats with (while in the project folder):

datum project info

The formats available for --format will be there under Plugins -> extractors. I could not find this information in the documentation... even resorting to trying to read the code to figure it out. By pure luck and desperation, I tried this command and it's there.

To reproduce this, be a beginner trying a basic workflow:

  • Oh, it supports YOLO-Ultralytics exporting, let me try that as the format.
  • Oh, the format name is invalid.
  • Well... Is there anywhere that shows the format arguments for the CLI, or somewhere that points me to them?
  • Spend a long time trying to find it, or give up on the tool entirely.

This should be easy information to find (and if it is, boy am I blind).

That being said, thank you for this amazing tool.
@vinnamkim
Copy link
Contributor

Hi @1dmesh,
Thank you for your valuable interest in our project. Your feedback on the user experience is truly appreciated. It helps us identify areas for improvement and enhances our project overall. I'll create a ticket to enhance our documentation and CLI as you suggested.

@vinnamkim vinnamkim added the user experience Questions about our products or things to improve user experience label Jun 25, 2024
@vinnamkim vinnamkim mentioned this issue Jul 22, 2024
Merged
6 tasks
vinnamkim added a commit that referenced this issue Jul 24, 2024
@vinnamkim
Add a new CLI command: datum format (#1570)
1f8e1e7 
### Summary

- This PR resolves https://jira.devtools.intel.com/browse/CVS-144954 and
#1545
- Add a new CLI command: `datum format`. It displays a list of data
format names supported by Datumaro. It can be useful for quick reference
of data format name used for other CLI command such as `datum convert
-if <data-format> -f <data-format>`.

### How to test
Added unit tests as well.

### Checklist
<!-- Put an 'x' in all the boxes that apply -->
- [x] I have added unit tests to cover my changes.​
- [ ] I have added integration tests to cover my changes.​
- [x] I have added the description of my changes into
[CHANGELOG](https://github.com/openvinotoolkit/datumaro/blob/develop/CHANGELOG.md).​
- [x] I have updated the
[documentation](https://github.com/openvinotoolkit/datumaro/tree/develop/docs)
accordingly

### License

- [x] I submit _my code changes_ under the same [MIT
License](https://github.com/openvinotoolkit/datumaro/blob/develop/LICENSE)
that covers the project.
  Feel free to contact the maintainers if that's a concern.
- [x] I have updated the license header for each file (see an example
below).

```python
# Copyright (C) 2024 Intel Corporation
#
# SPDX-License-Identifier: MIT
```

---------

Signed-off-by: Kim, Vinnam <[email protected]>
@vinnamkim
Copy link
Contributor

Added a new CLI command for this use case, #1570

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vinnamkim vinnamkim

Labels
user experience Questions about our products or things to improve user experience
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@vinnamkim @1dmesh