torchgeo/docs/index.rst

torchgeo
========

.. automodule:: torchgeo

.. toctree::
   :maxdepth: 2
   :caption: User Documentation

   user/installation
   user/contributing
   user/glossary
   user/alternatives

.. toctree::
   :maxdepth: 2
   :caption: Package Reference

   api/datamodules
   api/datasets
   api/losses
   api/models
   api/samplers
   api/trainers
   api/transforms

.. toctree::
   :maxdepth: 1
   :caption: Tutorials

   tutorials/getting_started
   tutorials/custom_raster_dataset
   tutorials/transforms
   tutorials/indices
   tutorials/trainers
   tutorials/pretrained_weights

.. toctree::
   :maxdepth: 1
   :caption: PyTorch Libraries

   PyTorch <https://pytorch.org/docs>
   torchaudio <https://pytorch.org/audio>
   torchtext <https://pytorch.org/text>
   torchvision <https://pytorch.org/vision>
   TorchElastic <https://pytorch.org/elastic/>
   TorchServe <https://pytorch.org/serve>
   PyTorch on XLA Devices <https://pytorch.org/xla/>
Keep API docs up-to-date 2021-06-29 21:42:47 +03:00			`torchgeo`
			`========`
Add documentation 2021-06-16 00:02:36 +03:00
Keep API docs up-to-date 2021-06-29 21:42:47 +03:00			`.. automodule:: torchgeo`

Add installation instructions (#153) * Add installation instructions * Comment out instructions that require a stable release 2021-09-22 17:41:52 +03:00			`.. toctree::`
			`:maxdepth: 2`
			`:caption: User Documentation`

			`user/installation`
Move contribution guide to documentation 2021-09-22 01:38:03 +03:00			`user/contributing`
Add installation instructions (#153) * Add installation instructions * Comment out instructions that require a stable release 2021-09-22 17:41:52 +03:00			`user/glossary`
Document TorchGeo alternatives (#1742) 2024-01-10 09:44:51 +03:00			`user/alternatives`
Add installation instructions (#153) * Add installation instructions * Comment out instructions that require a stable release 2021-09-22 17:41:52 +03:00
Add documentation 2021-06-16 00:02:36 +03:00			`.. toctree::`
			`:maxdepth: 2`
Keep API docs up-to-date 2021-06-29 21:42:47 +03:00			`:caption: Package Reference`
Add documentation 2021-06-16 00:02:36 +03:00
Move DataModules to torchgeo.datamodules (#321) * Move DataModules to torchgeo.datamodules * Clean up local imports 2021-12-24 05:10:50 +03:00			`api/datamodules`
Add tutorials to documentation 2021-08-20 01:48:08 +03:00			`api/datasets`
functionality for learning on the prior with QR loss and ChesapeakeCVPR data (#202) * adding QR loss functions for learning on the prior * chesapake learn on prior trainer with self-contained code for visualization * adding prior dataset to the chesapeake datasets; doesn't handle downloading or anything like that yet * updating init files to include chesapeake CVPR prior * adding FCNModified for learning on the prior * changing input to samplers to pass dataset instead of dataset.index * fixing style issues * Removing FCN_modified * Fixing super call and mypy in FCN model * Added learning on the prior extension * Update tests * Formatting * Adding QR loss * Added losses to docs * Removing trainer, moving datamodule * Combining chesapeake and chesapeake prior datamodules * Formatting * Test coverage * Formatting * Adding losses * Re-moving the datamodules around * Make loss function a torch Module * Version added * Fixed some stuff that got messed up in the rebase * Formatting * How'd this get there? * Change qr losses to expect probabilities instead of log-probabilities * Clean up test * Rename qr loss file * Renamed test file Co-authored-by: Caleb Robinson <calebrob6@gmail.com> 2021-12-28 23:56:14 +03:00			`api/losses`
Add tutorials to documentation 2021-08-20 01:48:08 +03:00			`api/models`
			`api/samplers`
			`api/trainers`
			`api/transforms`

			`.. toctree::`
Don't show tutorial sections 2021-09-03 21:37:18 +03:00			`:maxdepth: 1`
Add tutorials to documentation 2021-08-20 01:48:08 +03:00			`:caption: Tutorials`

Consolidate notebooks 2021-08-20 22:19:06 +03:00			`tutorials/getting_started`
Add custom RasterDataset notebook (#283) * Add custom RasterDataset notebook * Update docs index.rst * Update copyright, fix URL typo, and add verbose description * Add xview3 sample data * Update notebook * Show simple example first, complicated example second * Remove the second half of the notebook, can expand later 2021-12-22 02:29:15 +03:00			`tutorials/custom_raster_dataset`
Indices Transforms (#127) * draft indices transform * import sort * added AugmentationSequential wrapper for dicts * updated indices * fix dim concat bugs * format * add kornia dependency * add augmentationsequenal unit tests * add augmentationsequential support for boxes and mask dtypes * add indices tests * Draft indices tutorial notebook * move notebook to tutorials folder * mypy fixes * fix bug when only image key used in AugmentationSequential * Created using Colaboratory * added tutorial to docs * format * added kornia master branch dependency' * refactor notebook to use % cell magic and python to download files * revert kornia version * install kornia master branch for mypy checks * update mypy github action install order * fix divide by zero error in indices * Created using Colaboratory * fix nbsphinx errors * add TODO to remove kornia in tests action * format setup.cfg * minor fixes to indices * remove unecessary variable * update mask to cast to original dtype * removed unused ignore comment * added gray/rgb/multispectral unit tests * added tests with boxes * Created using Colaboratory * Created using Colaboratory * fix mypy issues * updated notebooks in docs * Updates to tutorials * Created using Colaboratory * Created using Colaboratory Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com> 2021-09-29 01:04:56 +03:00			`tutorials/transforms`
			`tutorials/indices`
Minor grammar fixes 2021-09-25 00:48:13 +03:00			`tutorials/trainers`
Add Multi-Weight Support API (#917) * load pretrained weights * change name millionaid * restructure and additional weights * rename sentinel1 weights * add vit small weights * forgot to add vit.py * struggling with test * wrong name failing test * feedback on tests * increase test coverage * fix failing test * fix failing test * fix failing test and add vit tests * fix failing vit test * torchgeo.models.utils * forgot utils file * typo num channels * nitpick docs, version torchvision * another try min dependencies * add documentation table * expand pytests to test pretrained weights on tasks * reverse changes to byol task * add tests to init pretrained weights from config * forgot to add the conf files * change path * increase test coverage * vit tests all pass locally including slow * now remote * fix tests another one * add a draft tutorial * run black on tutorial notebook * Tutorial typo fixes * Lower min torch/vision versions * Fix bad rebase * Remove dead code * Flake8 fixes * Consistent in_chans * Black fixes * bison > yacs * Remove one more reference * Download modified weights from hugging face * Add entrypoints * Add torch.hub support * progress arg is required * Fix model loading for resnet18 * Add transforms, update tests * VIT -> ViT * add seco weights * Fix type hints * Link to timm docs * Fix pydocstyle * Try to fix timm docs link * Fix tests * Nuke ignores * Ignore timm links * Add model API methods * Add to __init__ and document * Test model API functions * fix tests * Use correct documentation link for intersphinx * Typos * Fix Windows tests * meth -> func * Explicit function scope * weight-specific filename * Support enums in classification trainer * Update other trainers too * Fix regression tests * Fix classification tests * Fix byol tests * Fix types * progress_bar is required arg * Test weight enums * Fix pickling * Fix regression tests * Improve coverage of classification tests * Improve coverage of BYOL tests * Update resnet table * Update ViT table * Update get_state_dict usage * Remove unused YAML files * Update table widths * Documentation improvements * Tweak tables * Try to fix Windows tests * Revert "Try to fix Windows tests" This reverts commit 1325b13ff779b28adcaca36725e098ae8352a1d6. * Monkeypatch everything * Revert "Monkeypatch everything" This reverts commit e3e8d7d04231f8c0a39b5accd8f3d977aa7cbab2. * Revert "Revert "Monkeypatch everything"" This reverts commit 9b27bd705b06a743c092301c36802ce6e9503898. * Patch things not at the source * Fix missing import Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com> 2023-01-23 01:25:49 +03:00			`tutorials/pretrained_weights`
Keep API docs up-to-date 2021-06-29 21:42:47 +03:00
			`.. toctree::`
			`:maxdepth: 1`
			`:caption: PyTorch Libraries`
Add documentation 2021-06-16 00:02:36 +03:00
Keep API docs up-to-date 2021-06-29 21:42:47 +03:00			`PyTorch <https://pytorch.org/docs>`
			`torchaudio <https://pytorch.org/audio>`
			`torchtext <https://pytorch.org/text>`
			`torchvision <https://pytorch.org/vision>`
			`TorchElastic <https://pytorch.org/elastic/>`
			`TorchServe <https://pytorch.org/serve>`
Fix broken URLs (#1125) * Fix broken URLs * Flake8 fix * Don't change Chesapeake URL 2023-02-26 21:14:37 +03:00			`PyTorch on XLA Devices <https://pytorch.org/xla/>`