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 disk usage check before downloading files #19041

Merged
merged 12 commits into from
Nov 21, 2023

Conversation

tchaton
Copy link
Contributor

@tchaton tchaton commented Nov 21, 2023

What does this PR do?

This PR fixes a bug where files would be downloaded until there is no space left of the machine. This happens if the processing and removers aren't fast enough to catch up with the downloaders.

Fixes #<issue_number>

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

📚 Documentation preview 📚: https://pytorch-lightning--19041.org.readthedocs.build/en/19041/

cc @Borda @carmocca

@github-actions github-actions bot added the data (external) litdata package label Nov 21, 2023
Copy link
Contributor

github-actions bot commented Nov 21, 2023

⚡ Required checks status: All passing 🟢

Groups summary

🟢 lightning_data: CPU workflow
Check ID Status
data-cpu (macOS-11, lightning, 3.10, 2.1) success
data-cpu (ubuntu-20.04, lightning, 3.10, 2.1) success
data-cpu (windows-2022, lightning, 3.10, 2.1) success

These checks are required after the changes to src/lightning/data/streaming/data_processor.py, tests/tests_data/streaming/test_data_processor.py, .github/workflows/ci-tests-data.yml.

🟢 mypy
Check ID Status
mypy success

These checks are required after the changes to src/lightning/data/streaming/data_processor.py.

🟢 install
Check ID Status
install-pkg (ubuntu-22.04, app, 3.8) success
install-pkg (ubuntu-22.04, app, 3.11) success
install-pkg (ubuntu-22.04, fabric, 3.8) success
install-pkg (ubuntu-22.04, fabric, 3.11) success
install-pkg (ubuntu-22.04, pytorch, 3.8) success
install-pkg (ubuntu-22.04, pytorch, 3.11) success
install-pkg (ubuntu-22.04, lightning, 3.8) success
install-pkg (ubuntu-22.04, lightning, 3.11) success
install-pkg (ubuntu-22.04, notset, 3.8) success
install-pkg (ubuntu-22.04, notset, 3.11) success
install-pkg (macOS-12, app, 3.8) success
install-pkg (macOS-12, app, 3.11) success
install-pkg (macOS-12, fabric, 3.8) success
install-pkg (macOS-12, fabric, 3.11) success
install-pkg (macOS-12, pytorch, 3.8) success
install-pkg (macOS-12, pytorch, 3.11) success
install-pkg (macOS-12, lightning, 3.8) success
install-pkg (macOS-12, lightning, 3.11) success
install-pkg (macOS-12, notset, 3.8) success
install-pkg (macOS-12, notset, 3.11) success
install-pkg (windows-2022, app, 3.8) success
install-pkg (windows-2022, app, 3.11) success
install-pkg (windows-2022, fabric, 3.8) success
install-pkg (windows-2022, fabric, 3.11) success
install-pkg (windows-2022, pytorch, 3.8) success
install-pkg (windows-2022, pytorch, 3.11) success
install-pkg (windows-2022, lightning, 3.8) success
install-pkg (windows-2022, lightning, 3.11) success
install-pkg (windows-2022, notset, 3.8) success
install-pkg (windows-2022, notset, 3.11) success

These checks are required after the changes to src/lightning/data/streaming/data_processor.py.


Thank you for your contribution! 💜

Note
This comment is automatically generated and updates for 60 minutes every 180 seconds. If you have any other questions, contact carmocca for help.

@github-actions github-actions bot added the ci Continuous Integration label Nov 21, 2023
tests/tests_data/streaming/test_data_processor.py Outdated Show resolved Hide resolved

while (usage.free / 1000 / 1000 / 1000) <= threshold_in_gb:
sleep(sleep_time)
usage = shutil.disk_usage("/")
Copy link
Contributor

Choose a reason for hiding this comment

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

should probably check the disk usage with the path where we are writing to. E.g. instead of / it should be the "cache dir" probably.

Copy link
Contributor Author

@tchaton tchaton Nov 21, 2023

Choose a reason for hiding this comment

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

I think it is safer to check the overall machine state to avoid any failures as this would be a costly mistake.

Copy link
Contributor

Choose a reason for hiding this comment

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

My argument is that it would be a costly mistake not to measure the disk usage where we are saving. For example, if your /home is not on the same disk as /. The function could simply take a path as input, like

 _wait_for_disk_usage_higher_than_threshold(input_dir.path)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The root should include everything on the machine, so it would independent on wherever is home.

@tchaton tchaton requested a review from awaelchli November 21, 2023 16:36
tests/tests_data/streaming/test_data_processor.py Outdated Show resolved Hide resolved

while (usage.free / 1000 / 1000 / 1000) <= threshold_in_gb:
sleep(sleep_time)
usage = shutil.disk_usage("/")
Copy link
Contributor

Choose a reason for hiding this comment

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

My argument is that it would be a costly mistake not to measure the disk usage where we are saving. For example, if your /home is not on the same disk as /. The function could simply take a path as input, like

 _wait_for_disk_usage_higher_than_threshold(input_dir.path)

@mergify mergify bot added the ready PRs ready to be merged label Nov 21, 2023
@tchaton tchaton merged commit d3df127 into master Nov 21, 2023
53 checks passed
@tchaton tchaton deleted the add_disk_usage_check_before_downloading branch November 21, 2023 20:10
Borda pushed a commit that referenced this pull request Dec 19, 2023
Co-authored-by: thomas <[email protected]>
(cherry picked from commit d3df127)
lantiga pushed a commit that referenced this pull request Dec 20, 2023
Co-authored-by: thomas <[email protected]>
(cherry picked from commit d3df127)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration data (external) litdata package ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants