datumaro icon indicating copy to clipboard operation
datumaro copied to clipboard

CLI Format Documentation

Open 1dmesh opened this issue 7 months ago • 1 comments

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.

1dmesh avatar Jun 24 '24 21:06 1dmesh