-
Notifications
You must be signed in to change notification settings - Fork 379
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: reorganize tutorial hierarchy (#2439)
* Docs: redesign tutorial organization * Typo fixes * Try .ipynb links * Add input range * ruff * more fix * Fix filename
- Loading branch information
1 parent
b849ace
commit 769ad2e
Showing
8 changed files
with
86 additions
and
342 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Basic Usage | ||
=========== | ||
|
||
The following tutorials introduce the basic concepts and components of TorchGeo: | ||
|
||
* `Transforms <transforms.ipynb>`_: Preprocessing and data augmentation transforms for geospatial data | ||
* `Indices <indices.ipynb>`_: Spectral indices | ||
* `Pretrained Weights <pretrained_weights.ipynb>`_: Models and pretrained weights | ||
* `Lightning Trainers <trainers.ipynb>`_: PyTorch Lightning data modules and trainers | ||
|
||
.. toctree:: | ||
:hidden: | ||
:maxdepth: 1 | ||
|
||
transforms | ||
indices | ||
pretrained_weights | ||
trainers |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
Case Studies | ||
============ | ||
|
||
The following case studies present end-to-end workflows for common use cases of geospatial machine learning: | ||
|
||
* `Earth Surface Water <earth_surface_water.ipynb>`_: A workflow for mapping surface water, including lakes and rivers | ||
|
||
Do you have a use case that is missing from this list? Please open a pull request to add tutorials for your own use cases. | ||
|
||
.. toctree:: | ||
:hidden: | ||
:maxdepth: 1 | ||
|
||
earth_surface_water |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
Customization | ||
============= | ||
|
||
Is TorchGeo missing a dataset or model you need? Would you like to modify the default augmentations for a data module or extend a builtin trainer? | ||
|
||
The following tutorials will teach you how to customize TorchGeo to meet your needs: | ||
|
||
* `Custom Non-Geospatial Datasets <contribute_non_geo_dataset.ipynb>`_: How to create and contribute a new NonGeoDataset | ||
* `Custom Raster Datasets <custom_raster_dataset.ipynb>`_: How to create a new RasterDataset | ||
* `Custom Data Module <contribute_datamodule.ipynb>`_: How to create and contribute a new DataModule | ||
|
||
TorchGeo is a community-driven open source library. If there is a feature missing that you would like to add, please open a pull request to add it. See the ref:`contributing` guidelines to get started. | ||
|
||
.. toctree:: | ||
:hidden: | ||
:maxdepth: 1 | ||
|
||
contribute_non_geo_dataset | ||
custom_raster_dataset | ||
contribute_datamodule |
Oops, something went wrong.