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 contribution tutorial for Non-Geo Datasets #2451

Merged
merged 4 commits into from
Dec 8, 2024

Conversation

nilsleh
Copy link
Collaborator

@nilsleh nilsleh commented Dec 5, 2024

This is my shot at a "contribution guide" for new non-geo datasets. I am not sure what you were looking for exactly so I tried to recall the things I found difficult/unintuitive at the beginning and outline "building blocks".

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 5, 2024
@adamjstewart
Copy link
Collaborator

I am not sure what you were looking for exactly

Basically, looking for something similar to:

So taking a real dataset (e.g., EuroSAT) and showing step-by-step how to create a working dataset (and datamodule) for it. I didn't intend to add tests to the notebook, but those are a good plus I guess. You can add the above links to an Additional Reading section at the end.

P.S. Tutorial might be fine as is if you're busy. Likely won't get a chance to review this until tomorrow, I can just push directly to your branch if I want to make any final changes.

@adamjstewart adamjstewart mentioned this pull request Dec 6, 2024
25 tasks
@adamjstewart adamjstewart added this to the 0.6.2 milestone Dec 8, 2024
@adamjstewart adamjstewart enabled auto-merge (squash) December 8, 2024 13:58
@adamjstewart adamjstewart merged commit 04483d7 into microsoft:main Dec 8, 2024
19 of 20 checks passed
calebrob6 pushed a commit that referenced this pull request Dec 8, 2024
* add non-geodataset tutorial

* add to index

* Convert markdown code to code blocks

---------

Co-authored-by: Adam J. Stewart <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants