Skip to content

Commit 36d1474

Browse files
committed
Update documentation links and clean up config.md file
1 parent 0534d61 commit 36d1474

File tree

2 files changed

+2
-13
lines changed

2 files changed

+2
-13
lines changed

docs/config.md

+1-10
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,10 @@ matcher:
3131
th: 0.85
3232
```
3333

34-
### Default configuration
35-
36-
Note that all the defaults configurations of DIM, including local features, matchers and geometric verification, are in `src/deep_image_matching/config.py`.
37-
38-
39-
<!--
40-
**Page under construction...**
34+
### The Config Class
4135

4236
::: deep_image_matching.config.Config
4337
options:
4438
show_root_heading: true
4539
show_source: false
4640
members:
47-
-->
48-
49-

docs/getting_started.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Example: `python main.py --dir ./assets/example_cyprus --pipeline superpoint+lig
1919

2020
Other optional parameters are:
2121

22-
- `--config_file` `-c`: the path to the YAML configuration file containing the custom configuration. See the [Advanced configuration](#advanced-configuration) section (default: `None`, so default configuration is used)
22+
- `--config_file` `-c`: the path to the YAML configuration file containing the custom configuration. See the [Advanced configuration](./advanced_configuration.md) section (default: `None`, so default configuration is used)
2323
- `--strategy` `-s`: the strategy to use for matching the images. It can be `matching_lowres`, `bruteforce`, `sequential`, `retrieval`, `custom_pairs`. See [Matching strategies](#matching-strategies) section (default: `matching_lowres`)
2424
- `--quality` `-q`: the quality of the images to be matched. It can be `lowest`, `low`, `medium`, `high` or `highest`. See [Quality](#quality) section (default: `high`).
2525
- `tiling` `-t`: if passed, the images are tiled in 4 parts and each part is matched separately. This is useful for high-resolution images if you do not want to resize them. See [Tiling](#tiling) section (default: `None`).
@@ -54,7 +54,6 @@ The GUI loads the available configurations from [`config.py`](https://github.com
5454

5555
If you want to use Deep_Image_Matching from a Jupyter notebook, you can check the examples in the [`notebooks`](https://github.com/3DOM-FBK/deep-image-matching/tree/master/notebooks) folder.
5656

57-
5857
## Pipelines
5958

6059
The `pipeline` parameter defines the combination of local feature extractor and matcher to be used for the matching is is defined by the `--pipeline` option in the CLI.
@@ -130,4 +129,3 @@ If you want to run the matching by tile, you can choose different approaches for
130129
- `exhaustive`: the images are divided into a regular grid of size 2400x2000 px to extract the features. The matching is carried out by matching all the possible combinations of tiles (brute-force). This method can be very slow for large images or in combination with the `highest` quality option and, in some cases, it may lead to error in the geometric verification if too many wrong matches are detected.
131130

132131
To control the tile size and the tile overlap, refer to the [Advanced configuration](./advanced_configuration.md) section.
133-

0 commit comments

Comments
 (0)