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

Error in main readme: we provide train.py and evaluate.py scripts to train and evaluate #1626

Closed
robmarkcole opened this issue Oct 6, 2023 · 1 comment · Fixed by #1628
Closed
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@robmarkcole
Copy link
Contributor

Issue

In Reproducibility with Lightning it states we provide train.py and evaluate.py scripts to train and evaluate but as far as I can see these files do not exist. The correct instructions are in the v0.5.0 release notes.

I also spotted reference to train.py in a few experiments, and that may require updating.

Fix

Wanted to check my understanding before making a PR

@robmarkcole robmarkcole added the documentation Improvements or additions to documentation label Oct 6, 2023
@adamjstewart adamjstewart added this to the 0.5.1 milestone Oct 6, 2023
@adamjstewart
Copy link
Collaborator

Correct, the new torchgeo (or python -m torchgeo) script is the replacement for train.py.

I also noted this in #1196. We should probably copy that whole section of the release notes to the README, as the CLI isn't documented at all right now.

Feel free to submit a PR to add just the script stuff or all of #1196. Otherwise I'll definitely get to it before the next patch release.

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 a pull request may close this issue.

2 participants