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 a local downloader with cache #19511

Closed

Conversation

mads-oestergaard
Copy link
Contributor

@mads-oestergaard mads-oestergaard commented Feb 22, 2024

What does this PR do?

This PR adds a file format (local:) that users can prefix local paths with to get the files cached by lightning.

Motivation:
I would like to store data on a network drive that our on-prem compute nodes can mount and use, but I would also like to cache the chunks to not over-burden the network connection. With this PR, instead of doing this (which also works):

from lightning.data import StreamingDataset

dataset = StreamingDataset(input_dir="/data/shared-drive/some-data")

one can do

from lightning.data import StreamingDataset

dataset = StreamingDataset(input_dir="local:/data/shared-drive/some-data")

which will be the same, but with caching.

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--19511.org.readthedocs.build/en/19511/

@github-actions github-actions bot added the data (external) litdata package label Feb 22, 2024
@mads-oestergaard
Copy link
Contributor Author

@tchaton should I move this PR to litdata?

@tchaton
Copy link
Contributor

tchaton commented Feb 26, 2024

Hey @mads-oestergaard. Yes, this would be great ! So you keep the contribution ;) And if you could add a test, this would be fab ;)

@mads-oestergaard
Copy link
Contributor Author

I'm closing this then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data (external) litdata package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants