Better README #626
Merged
Better README #626
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adamjstewart
commented
Jun 24, 2022
|
|
||
| See our [installation instructions](#installation), [documentation](#documentation), and [examples](#example-usage) to learn how to use TorchGeo. |
There was a problem hiding this comment.
These links worked on GitHub but not on PyPI. We could fix them, but I'm not sure how useful they actually are since these 3 sections immediately follow the links.
|
|
||
| TorchGeo includes a number of [*benchmark*](https://torchgeo.readthedocs.io/en/latest/api/datasets.html#non-geospatial-datasets) datasets, datasets that include both input images and target labels. This includes datasets for tasks like image classification, regression, semantic segmentation, object detection, instance segmentation, change detection, and more. | ||
| <img src="https://raw.githubusercontent.com/microsoft/torchgeo/main/images/geodataset.png" alt="Example application in which we combine Landsat and CDL and sample from both"/> |
There was a problem hiding this comment.
By using absolute links to the files in GitHub, we don't have to include the images in the sdist we upload to PyPI.
|
|
||
| We provide a script, `train.py` for training models using a subset of the datasets. We do this with the PyTorch Lightning `LightningModule`s and `LightningDataModule`s implemented under the `torchgeo.trainers` namespace. | ||
| The `train.py` script is configurable via the command line and/or via YAML configuration files. See the [conf/](conf/) directory for example configuration files that can be customized for different training runs. | ||
| In our GitHub repo, we provide `train.py` and `evaluate.py` scripts to train and evaluate the performance of models using these datamodules and trainers. These scripts are configurable via the command line and/or via YAML configuration files. See the [conf](https://github.com/microsoft/torchgeo/blob/main/conf) directory for example configuration files that can be customized for different training runs. |
There was a problem hiding this comment.
Can add predict.py to this list once #560 is complete.
| url = {https://github.com/microsoft/torchgeo}, | ||
| year = {2021} | ||
| } | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| This project welcomes contributions and suggestions. If you would like to submit a pull request, see our [Contribution Guide](https://torchgeo.readthedocs.io/en/latest/user/contributing.html) for more information. | ||
| This project welcomes contributions and suggestions. If you would like to submit a pull request, see our [Contribution Guide](https://torchgeo.readthedocs.io/en/stable/user/contributing.html) for more information. |
There was a problem hiding this comment.
Changed all of the documentation links from "latest" to "stable" to match our new default documentation version.
calebrob6
approved these changes
Jun 29, 2022
Merged
yichiac
pushed a commit
to yichiac/torchgeo
that referenced
this pull request
Apr 29, 2023
* Better README * Update description
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates our README to include similar verbiage and images as our recent blog. At this point, there's a lot of redundancy between the blog and the README. I think that's fine since the examples in the README will continue to be updated long after the blog post is obsolete. But if you feel like it's too similar or have suggestions to make them different let me know.
Closes #589