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.

Sign up for GitHub

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

Jump to bottom

Docs/trainers for Classification and Segmentation Task #852

Merged
merged 7 commits into from
Nov 15, 2022
Merged

Docs/trainers for Classification and Segmentation Task #852

merged 7 commits into from
Nov 15, 2022

Conversation

nilsleh
Copy link
Collaborator

@nilsleh nilsleh commented Oct 15, 2022

  • I thought it would be useful to add some documentation to the trainers, just to clarify how flexible they are and the wide choices of models they support without someone having to dig.
  • The documentation for ClassificationTask states that possible weights are Either “random”, “imagenet_only”, “imagenet_and_random”, or “random_rgb” but only "imagenet" or "random" work otherwise you get an error, so I corrected the documentation for that
  • In the documentation there were keyword args missing that were actually necessary to use the task with a trainer, so I added documentation for the required keywords

@github-actions github-actions bot added the trainers PyTorch Lightning trainers label Oct 15, 2022
adamjstewart
adamjstewart reviewed Oct 15, 2022
View reviewed changes
Copy link
Collaborator

@adamjstewart adamjstewart left a comment

Choose a reason for hiding this comment

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

Thanks, this was much needed!

torchgeo/trainers/classification.py Outdated Show resolved Hide resolved
@adamjstewart adamjstewart added this to the 0.3.2 milestone Oct 15, 2022
adamjstewart
adamjstewart reviewed Oct 15, 2022
View reviewed changes
torchgeo/trainers/segmentation.py Outdated Show resolved Hide resolved
torchgeo/trainers/segmentation.py Outdated Show resolved Hide resolved
@nilsleh nilsleh mentioned this pull request Oct 16, 2022
Merged
adamjstewart
adamjstewart reviewed Oct 16, 2022
View reviewed changes
torchgeo/trainers/classification.py Outdated Show resolved Hide resolved
torchgeo/trainers/segmentation.py Outdated Show resolved Hide resolved
torchgeo/trainers/segmentation.py Outdated Show resolved Hide resolved
adamjstewart
adamjstewart previously approved these changes Oct 16, 2022
View reviewed changes
@calebrob6 calebrob6 merged commit 8ac886f into microsoft:main Nov 15, 2022
@adamjstewart adamjstewart modified the milestones: 0.3.2, 0.4.0 Jan 23, 2023
yichiac pushed a commit to yichiac/torchgeo that referenced this pull request Apr 29, 2023
@nilsleh
Docs/trainers for Classification and Segmentation Task (microsoft#852)
4478f6d 
* progess on docs

* add docs

* no versionchange for docs

* remove versionchanged

* verb typo

* add space for multiline f string

* do not print model list but docstring instead
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@isaaccorley isaaccorley isaaccorley left review comments

@adamjstewart adamjstewart adamjstewart approved these changes

Assignees
No one assigned
Labels
trainers PyTorch Lightning trainers
Projects
None yet
Milestone
0.4.0
Development

Successfully merging this pull request may close these issues.
4 participants
@nilsleh @adamjstewart @isaaccorley @calebrob6