From f68cec5a2e5db3087a25a021b4e8a3bfb28018a0 Mon Sep 17 00:00:00 2001 From: Caleb Robinson Date: Sun, 17 Oct 2021 10:14:26 -0700 Subject: [PATCH] Docs/models (#199) * Making sphinx build in parallel * Cleaning up the model docs --- docs/Makefile | 2 +- docs/api/models.rst | 31 ++++++++++++++++++++++++++++++- 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index b94ee9c0a..d60f3fcc3 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -6,7 +6,7 @@ # You can set these variables from the command line, and also # from the environment for the first two. SPHINX_BUILD ?= sphinx-build -SPHINX_BUILD_OPTS ?= -W --keep-going +SPHINX_BUILD_OPTS ?= -W -j auto --keep-going SOURCE_DIR = . BUILD_DIR = _build diff --git a/docs/api/models.rst b/docs/api/models.rst index 4b597541f..ed1b40a37 100644 --- a/docs/api/models.rst +++ b/docs/api/models.rst @@ -1,4 +1,33 @@ torchgeo.models ================= -.. automodule:: torchgeo.models +.. module:: torchgeo.models + +Change Star +^^^^^^^^^^^ + +.. autoclass:: ChangeStar +.. autoclass:: ChangeStarFarSeg +.. autoclass:: ChangeMixin + +Foreground-aware Relation Network (FarSeg) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: FarSeg + +Fully-convolutional Network (FCN) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: FCN + +Fully Convolutional Siamese Networks for Change Detection +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: FCEF +.. autoclass:: FCSiamConc +.. autoclass:: FCSiamDiff + +Random-convolutional feature (RCF) extractor +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: RCF