Skip to content

Commit 07f0258

Browse files
authored
Merge pull request #101 from CosmoStat/fix_broken_links
Fix Broken Links in documentation
2 parents d7b23f3 + f7fde94 commit 07f0258

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/source/configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Next, we shall describe each configuration file.
3030
(data_config)=
3131
## Data Configuration
3232

33-
The file [data_config.yaml](https://github.com/CosmoStat/wf-psf/blob/dummy_main/config/data_config.yaml) stores the metadata for generating training and test data sets or retrieving existing ones. A set of training and test data is provided in the `data/coherent_euclid_dataset` directory. `Wavediff` will automatically retrieve the dataset within its directory tree. In the field `data_dir`, the user should specify the sub-path to the data directory as in the example below. The actual name of the dataset file is provided as an entry to the field `file`. However, new training and test data sets can be produced with the parameters in the file, which *should be* provided to the `simPSF` code although not at present (implementation upgrade pending).
33+
The file [data_config.yaml](https://github.com/CosmoStat/wf-psf/blob/main/config/data_config.yaml) stores the metadata for generating training and test data sets or retrieving existing ones. A set of training and test data is provided in the `data/coherent_euclid_dataset` directory. `Wavediff` will automatically retrieve the dataset within its directory tree. In the field `data_dir`, the user should specify the sub-path to the data directory as in the example below. The actual name of the dataset file is provided as an entry to the field `file`. However, new training and test data sets can be produced with the parameters in the file, which *should be* provided to the `simPSF` code although not at present (implementation upgrade pending).
3434

3535
```
3636
# Training and test data sets for training and/or metrics evaluation
@@ -54,7 +54,7 @@ data:
5454
(training_config)=
5555
## Training Configuration
5656

57-
The file [training_config.yaml](https://github.com/CosmoStat/wf-psf/blob/dummy_main/config/training_config.yaml) is used to configure the settings for the training pipeline task. The first line contains the parent key `training`. All of the following child keys are treated as values of the `training` key. Above each child key a description is provided. Below is an abridged example of this:
57+
The file [training_config.yaml](https://github.com/CosmoStat/wf-psf/blob/main/config/training_config.yaml) is used to configure the settings for the training pipeline task. The first line contains the parent key `training`. All of the following child keys are treated as values of the `training` key. Above each child key a description is provided. Below is an abridged example of this:
5858

5959
```
6060
training:
@@ -90,7 +90,7 @@ Training hyperparameters, defined by the parent key: `training_hparams`, include
9090
(metrics_config)=
9191
## Metrics Configuration
9292

93-
The [metrics_config.yaml](https://github.com/CosmoStat/wf-psf/blob/dummy_main/config/metrics_config.yaml) file stores the configuration parameters for the WaveDiff pipeline to perform computations of the four metrics listed in the table on a trained PSF model, as applied in {cite:t}`Liaudat:23`.
93+
The [metrics_config.yaml](https://github.com/CosmoStat/wf-psf/blob/main/config/metrics_config.yaml) file stores the configuration parameters for the WaveDiff pipeline to perform computations of the four metrics listed in the table on a trained PSF model, as applied in {cite:t}`Liaudat:23`.
9494

9595
| Metric type | Description |
9696
| --- | ----------- |
@@ -213,7 +213,7 @@ The `metrics` package is run using [TensorFlow](https://www.tensorflow.org) to r
213213
(plotting_config)=
214214
## Plot Configuration
215215

216-
The [plotting_config.yaml](https://github.com/CosmoStat/wf-psf/blob/dummy_main/config/plotting_config.yaml) file stores the configuration parameters for the WaveDiff pipeline to generate plots for the metrics listed in the {ref}`metrics settings table <metrics_settings>` for each data set.
216+
The [plotting_config.yaml](https://github.com/CosmoStat/wf-psf/blob/main/config/plotting_config.yaml) file stores the configuration parameters for the WaveDiff pipeline to generate plots for the metrics listed in the {ref}`metrics settings table <metrics_settings>` for each data set.
217217

218218
An example of the contents of the `plotting_config.yaml` file is shown below.
219219

@@ -283,7 +283,7 @@ plotting_params:
283283
(master_config_file)=
284284
## Master Configuration
285285

286-
The `configs.yaml` file is the master configuration file that is used to define all of the pipeline tasks to be submitted and executed by `WaveDiff` during runtime. In this file, the user lists the processing tasks (one or more) to be performed by setting the values of the associated configuration variables `{pipeline_task}_conf` and the name of the configuration file `{pipeline_task}_config.yaml`. See an example below to configure `WaveDiff` to launch a sequence of runs to train models 1...n with their respective configurations given in the files `training_config_{id}.yaml`.
286+
The [configs.yaml](https://github.com/CosmoStat/wf-psf/blob/main/config/configs.yaml) file is the master configuration file that is used to define all of the pipeline tasks to be submitted and executed by `WaveDiff` during runtime. In this file, the user lists the processing tasks (one or more) to be performed by setting the values of the associated configuration variables `{pipeline_task}_conf` and the name of the configuration file `{pipeline_task}_config.yaml`. See an example below to configure `WaveDiff` to launch a sequence of runs to train models 1...n with their respective configurations given in the files `training_config_{id}.yaml`.
287287

288288
```
289289
---

0 commit comments

Comments
 (0)