Skip to content

Commit

Permalink
Add a cross-reference in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kostrykin committed Sep 18, 2024
1 parent 3604f40 commit 4a1ca08
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ After this initialization routine, SuperDSM is ready to use:
cfg = superdsm.Config()
data, _, _ = pipeline.process_image(img, cfg)
In this example, the default set of hyperparameters will be used. The parameters can be changed using the ``cfg`` object (see the :py:class:`repype.config.Config` class API). The available hyperparameters are described in the documentation of the respective stages employed in the pipeline.
In this example, the default set of hyperparameters will be used. The parameters can be changed using the ``cfg`` object (see the :py:class:`repype.config.Config` class API). The available hyperparameters are described in the documentation of the respective stages employed in the :ref:`pipeline <pipeline>`.

The variable ``img`` must be a two-dimensional ``numpy.ndarray`` object which represents the raw image intensities. Images can be loaded from file using :py:meth:`~superdsm.io.imread`.

Expand Down

0 comments on commit 4a1ca08

Please sign in to comment.