Update the documentation to remove deprecated features#1840
Merged
Conversation
Signed-off-by: Grégoire Payen de La Garanderie <gregoire.payen.de.la.garanderie@intel.com>
Signed-off-by: Grégoire Payen de La Garanderie <gregoire.payen.de.la.garanderie@intel.com>
…les. Signed-off-by: Grégoire Payen de La Garanderie <gregoire.payen.de.la.garanderie@intel.com>
…les. Signed-off-by: Grégoire Payen de La Garanderie <gregoire.payen.de.la.garanderie@intel.com>
| - Compute dataset statistics | ||
| ```console | ||
| datum stats -p <path/to/project/> | ||
| datumaro stats /path/to/dataset:coco |
Contributor
There was a problem hiding this comment.
The previous files in this PR all use datum as the command name. Why is this one different?
Contributor
Author
There was a problem hiding this comment.
Good catch, I have battled pretty hard with Copilot to avoid it doing this change. The issue is that the Python package is called datumaro and when calling the CLI help using Python (i.e. python -m datumaro convert --help), the first line says Usage: datumaro convert ... which is really confusing.
I am almost thinking of renaming the CLI to datumaro instead of datum to resolve the confusion. Anyway, for now, I have reverted it.
AlbertvanHouten
approved these changes
Aug 27, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the documentation to remove deprecated features. I have fixed the documentation of the download command which was outdated. I have also added a new "kaggle" extras dependency group to install the correct dependencies for downloading from Kaggle. I also fixed the description of some commands and well as some error messages.
I also disabled the git-check pre-commit because it conflicts with .rst files and I couldn’t find a way to ignore those; we can re-enable it if we find a better way.
How to test
Checklist
License
Feel free to contact the maintainers if that's a concern.