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

[Enhance] Support dumping datasets to pkl file #1037

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

shufanwu
Copy link
Contributor

@shufanwu shufanwu commented Apr 1, 2023

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Support dumping datasets to pkl file https://github.com/open-mmlab/mmengine/issues/896

Modification

add load and dump function for data_list in base_dataset.py

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repos?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@HAOCHENYE
Copy link
Collaborator

Thanks for your contribution and sorry for the late response. I think that the dump and load should be used like this:

# prepare dataset
dataset = XXXDataset(...)
ori_dataste.dump('saved.pkl')

new_dataset = Dataset.load('saved.pkl')

It means that the dump method should dump all data information, including data_list(unserialized) and data_meta to the file, and load should be a classmethod, which can load the file and recover the original dataset.

@zhouzaida zhouzaida linked an issue Apr 11, 2023 that may be closed by this pull request
@HAOCHENYE
Copy link
Collaborator

Hi, thanks for your contribution. The lint seems failed. BTW, I'll test load and dump in some real dataset ASAP 👍

@HAOCHENYE HAOCHENYE added this to the 0.7.4 milestone Apr 23, 2023
Copy link

codecov bot commented Sep 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@83c4f3e). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1037   +/-   ##
=======================================
  Coverage        ?   76.43%           
=======================================
  Files           ?      139           
  Lines           ?    11211           
  Branches        ?     2253           
=======================================
  Hits            ?     8569           
  Misses          ?     2280           
  Partials        ?      362           
Flag Coverage Δ
unittests 76.43% <100.00%> (?)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] Support dumping datasets to pkl file
2 participants