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 documentation on datasets and dataloaders #234

Merged
merged 7 commits into from
Apr 28, 2024

Conversation

anwai98
Copy link
Contributor

@anwai98 anwai98 commented Apr 4, 2024

This PR addresses the following:

  • Add type hints for majority of the dataset-related functionalities
  • Add a markdown documentation in the torch_em.data.datasets submodule, to briefly explain the available datasets and supported data design choices for creating dataloaders
  • (WIP) Add a tutorial notebook on how to create datasets / dataloaders

@anwai98 anwai98 changed the title Add documentation on datasets and dataloaders in torch-em Add documentation on datasets and dataloaders Apr 4, 2024
@anwai98
Copy link
Contributor Author

anwai98 commented Apr 12, 2024

@constantinpape This is ready to review from my side!

Copy link
Owner

@constantinpape constantinpape left a comment

Choose a reason for hiding this comment

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

The code changes look good, but we should move the markdown file.

I haven't reviewed the notebook itself yet.

torch_em/data/datasets/README.md Outdated Show resolved Hide resolved
@constantinpape
Copy link
Owner

I will merge for now. We can update this later when overhauling the datasets.

@constantinpape constantinpape merged commit cf6f674 into constantinpape:main Apr 28, 2024
2 checks passed
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.

None yet

2 participants