Skip to content

Commit

Permalink
Try .ipynb links
Browse files Browse the repository at this point in the history
  • Loading branch information
adamjstewart committed Dec 8, 2024
1 parent 9f93361 commit b2e871c
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 14 deletions.
8 changes: 4 additions & 4 deletions docs/tutorials/basic_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ Basic Usage

The following tutorials introduce the basic concepts and components of TorchGeo:

* `Transforms <transforms>`_: Preprocessing and data augmentation transforms for geospatial data
* `Indices <indices>`_: Spectral indices
* `Pretrained Weights <pretrained_weights>`_: Models and pretrained weights
* `Lightning Trainers <trainers>`: PyTorch Lightning data modules and trainers
* `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:
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/case_studies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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>`_: A workflow for mapping surface water, including lakes and rivers
* `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.

Expand Down
10 changes: 5 additions & 5 deletions docs/tutorials/customization.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Customization and Contributing
==============================
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>`_: How to create and contribute a new NonGeoDataset
* `Custom Raster Datasets <custom_raster_datasets>`_: How to create a new RasterDataset
* `Custom Data Module <contribute_datamodule>`_: How to create and contribute a new DataModule
* `Custom Non-Geospatial Datasets <contribute_non_geo_dataset.ipynb>`_: How to create and contribute a new NonGeoDataset
* `Custom Raster Datasets <custom_raster_datasets.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.

Expand Down
7 changes: 3 additions & 4 deletions docs/tutorials/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ New to deep learning or remote sensing? First time using PyTorch or TorchGeo? Yo

The following tutorials will teach you enough to get started:

* `Introduction to PyTorch <pytorch>`_: A brief overview of deep learning with PyTorch
* `Introduction to Geospatial Data <geospatial>`_: A brief overview of the challenges of working with geospatial data
* `Introduction to TorchGeo <torchgeo>`_: A brief overview of the design of TorchGeo

* `Introduction to PyTorch <pytorch.ipynb>`_: A brief overview of deep learning with PyTorch
* `Introduction to Geospatial Data <geospatial.ipynb>`_: A brief overview of the challenges of working with geospatial data
* `Introduction to TorchGeo <torchgeo.ipynb>`_: A brief overview of the design of TorchGeo

.. toctree::
:hidden:
Expand Down

0 comments on commit b2e871c

Please sign in to comment.