Skip to content

Commit

Permalink
Doc: Update all wiki links to point back to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
qin-yu committed Feb 6, 2024
1 parent 42bd070 commit 3ab74d2
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
12 changes: 7 additions & 5 deletions docs/chapters/getting_started/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ then, start the plantseg in napari
```bash
$ plantseg --napari
```
A more in depth guide can be found in our [wiki](https://github.com/hci-unihd/plant-seg/wiki/Napari).
A more in depth guide can be found in our [documentation (GUI)](https://hci-unihd.github.io/plant-seg/chapters/plantseg_interactive_napari/).

## Pipeline Usage (GUI)
PlantSeg app can also be started in a GUI mode, where basic user interface allows to configure and run the pipeline.
First, activate the newly created conda environment with:
Expand All @@ -23,7 +24,8 @@ then, run the GUI by simply typing:
```bash
$ plantseg --gui
```
A more in depth guide can be found in our [wiki](https://github.com/hci-unihd/plant-seg/wiki/PlantSeg-Classic-GUI).
A more in depth guide can be found in our [documentation (Classic GUI)](https://hci-unihd.github.io/plant-seg/chapters/plantseg_classic_gui/).

## Pipeline Usage (command line)
Our pipeline is completely configuration file based and does not require any coding.

Expand All @@ -35,6 +37,6 @@ then, one can just start the pipeline with
```bash
plantseg --config CONFIG_PATH
```
where `CONFIG_PATH` is the path to the YAML configuration file. See [config.yaml](https://github.com/hci-unihd/plant-seg/blob/master/examples/config.yaml) for a sample configuration
file and our [wiki](https://github.com/hci-unihd/plant-seg/wiki/PlantSeg-Classic-CLI) for a
detailed description of the parameters.
where `CONFIG_PATH` is the path to the YAML configuration file. See [config.yaml](examples/config.yaml) for a sample configuration
file and our [documentation (CLI)](https://hci-unihd.github.io/plant-seg/chapters/plantseg_classic_cli/) for a
detailed description of the parameters.
6 changes: 3 additions & 3 deletions docs/chapters/plantseg_classic_cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ of all parameters.
* `path` attribute: is used to define either the file to process or the directory containing the data.
* `preprocessing` attribute: contains a simple set of possible operations one would need to run on their data before calling the neural network.
This step can be skipped if data is ready for neural network processing.
Detailed instructions can be found at [Data Processing](https://github.com/hci-unihd/plant-seg/wiki/Data-Processing).
Detailed instructions can be found at [Classic GUI (Data Processing)](https://hci-unihd.github.io/plant-seg/chapters/plantseg_classic_gui/data_processing.html).
* `cnn_prediction` attribute: contains all parameters relevant for predicting with a neural network.
Description of all pre-trained models provided with the package is described below.
Detailed instructions can be found at [Predictions](https://github.com/hci-unihd/plant-seg/wiki/Predictions).
Detailed instructions can be found at [Classic GUI (Predictions)](https://hci-unihd.github.io/plant-seg/chapters/plantseg_classic_gui/cnn_predictions.html).
* `segmentation` attribute: contains all parameters needed to run the partitioning algorithm (i.e., final Segmentation).
Detailed instructions can be found at [Segmentation](https://github.com/hci-unihd/plant-seg/wiki/Segmentation.md).
Detailed instructions can be found at [Classic GUI (Segmentation)](https://hci-unihd.github.io/plant-seg/chapters/plantseg_classic_gui/segmentation.html).

## Additional information

Expand Down
2 changes: 1 addition & 1 deletion docs/chapters/plantseg_classic_gui/segmentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The segmentation widget allows using very powerful graph partitioning techniques to obtain a segmentation from the
input stacks.
The input of this widget should be the output of the [CNN-predictions widget](https://github.com/hci-unihd/plant-seg/wiki/CNN-Predictions).
The input of this widget should be the output of the [CNN-predictions widget](https://hci-unihd.github.io/plant-seg/chapters/plantseg_classic_gui/cnn_predictions.html).
If the boundary prediction stage fails for any reason, a raw image could be used (especially if the cell boundaries are
very sharp, and the noise is low) but usually does not yield satisfactory results.

Expand Down

0 comments on commit 3ab74d2

Please sign in to comment.