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

Add datumaro binary format documentation #880

Merged

Conversation

vinnamkim
Copy link
Contributor

@vinnamkim vinnamkim commented Mar 22, 2023

Summary

  • Ticket no. 104511
  • Add datumaro.md and datumaro_binary.md to site/content/en/docs/formats/.
  • Add notebooks/09_encrypt_dataset.ipynb

How to test

Checklist

  • I have added unit tests to cover my changes.​
  • I have added integration tests to cover my changes.​
  • I have added the description of my changes into CHANGELOG.​
  • I have updated the documentation accordingly

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.
  • I have updated the license header for each file (see an example below)
# Copyright (C) 2023 Intel Corporation
#
# SPDX-License-Identifier: MIT

vinnamkim and others added 12 commits March 20, 2023 10:04
* Update CHANGLOG.md - v1.1.0rc1
* Update version.py
* Update CHANGELOG.md format

Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
* Update PR template

* Update PR template
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@vinnamkim vinnamkim added DOC Improvements or additions to documentation RELEASE labels Mar 22, 2023
@vinnamkim vinnamkim added this to the 1.1.0 milestone Mar 22, 2023
…aro-binary-format

Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
…aro-binary-format

Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
@vinnamkim vinnamkim marked this pull request as ready for review March 22, 2023 13:07
@codecov-commenter
Copy link

codecov-commenter commented Mar 22, 2023

Codecov Report

Patch coverage: 50.00% and project coverage change: -0.01 ⚠️

Comparison is base (fa7562c) 78.56% compared to head (ac1de81) 78.55%.

Additional details and impacted files
@@                Coverage Diff                 @@
##           releases/1.1.0     #880      +/-   ##
==================================================
- Coverage           78.56%   78.55%   -0.01%     
==================================================
  Files                 205      205              
  Lines               24949    24953       +4     
  Branches             5009     5011       +2     
==================================================
+ Hits                19601    19603       +2     
- Misses               4222     4223       +1     
- Partials             1126     1127       +1     
Flag Coverage Δ
macos-11_Python-3.8 77.54% <50.00%> (-0.01%) ⬇️
ubuntu-20.04_Python-3.8 78.55% <50.00%> (-0.01%) ⬇️
windows-2019_Python-3.8 78.49% <50.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...o/plugins/data_formats/datumaro_binary/exporter.py 96.03% <50.00%> (-1.90%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
Copy link
Contributor

@sooahleex sooahleex left a comment

Choose a reason for hiding this comment

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

Looks good to me. In my opinion, it seems better to add comments for Export to other formats like

Examples:
-Export dataset from datumaro to voc format:

Signed-off-by: Kim, Vinnam <vinnam.kim@intel.com>
@vinnamkim
Copy link
Contributor Author

I updated it with the comments from @sooahleex and @JihwanEom and added some more detail guides for CLI dataset encryption usage.

@vinnamkim vinnamkim merged commit 8a51c8e into openvinotoolkit:releases/1.1.0 Mar 23, 2023
@vinnamkim vinnamkim deleted the doc/datumaro-binary-format branch March 23, 2023 02:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOC Improvements or additions to documentation RELEASE
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants