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 TorchGeo CLI tutorial #2479

Merged
merged 2 commits into from
Dec 19, 2024
Merged

Conversation

adamjstewart
Copy link
Collaborator

Basically copied the docs from the README to a tutorial.

@adamjstewart adamjstewart added this to the 0.6.2 milestone Dec 19, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 19, 2024
@adamjstewart adamjstewart mentioned this pull request Dec 8, 2024
25 tasks
@calebrob6
Copy link
Member

torchgeo validate and torchgeo test won't use the trained model by default

@adamjstewart
Copy link
Collaborator Author

Yeah, I'm not sure if there's an easy way to know the name of the trained model checkpoint to use. Maybe we can specify the name to use? I wish --best worked.

@calebrob6
Copy link
Member

You can setup a ModelCheckpoint to save last then point it to /tmp/eurosat100/lightning_logs/version_0/checkpoints/last.ckpt

@adamjstewart
Copy link
Collaborator Author

Hmm, I'll look into it, but I'm hoping to not make the config.yaml too complicated.

@calebrob6
Copy link
Member

Then we need to be really clear that "torchgeo test" and "torchgeo validate" are just going to return results from a random initialized model (which is.... not helpful). I think a reader would expect "torchgeo test" to test the trained model as the tutorial is written currently. We should also show users how to actually test their model too because that's going to be what people want to do with "test" or "validate" lol

@adamjstewart
Copy link
Collaborator Author

Fixed

@calebrob6 calebrob6 merged commit 7bcb6d4 into microsoft:main Dec 19, 2024
20 checks passed
@adamjstewart adamjstewart deleted the tutorials/cli branch December 19, 2024 21:37
adamjstewart added a commit that referenced this pull request Dec 19, 2024
* Add TorchGeo CLI tutorial

* Pass checkpoint path
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