Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update links to example configs in documentation #86

Closed
jeipollack opened this issue Nov 22, 2023 · 3 comments · Fixed by #101 or #104
Closed

Update links to example configs in documentation #86

jeipollack opened this issue Nov 22, 2023 · 3 comments · Fixed by #101 or #104
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@jeipollack
Copy link
Contributor

jeipollack commented Nov 22, 2023

Links to the example config files point in the documentation to the now deleted dummy-main branch.
data_config.yaml
training_config.yaml
metrics_config.yaml
plotting_config.yaml

Update the links to point to correct config file in the main branch (see here).

@jeipollack jeipollack added bug Something isn't working documentation Improvements or additions to documentation labels Nov 22, 2023
@jeipollack jeipollack self-assigned this Nov 22, 2023
@jeipollack
Copy link
Contributor Author

I forgot this link is also broken:

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`.

It should be replaced with this one: https://github.com/CosmoStat/wf-psf/blob/146725f2c2209bf3174c88c07a116e9ce28fff9a/config/configs.yaml

@nadamoukaddem
Copy link
Contributor

In certain sections, there are missing links as illustrated below. These links need to be added ?

Note, in this version of WaveDiff produces a single plot per each metric per trained model. To display all of the metrics results for each trained model in a single plot, the user must do so in a different run following the steps defined in the section [Plot Configuration](plotting_config). The next upgrade to WaveDiff will feature options to produce independent metrics plots per trained model or a single master plot comparing the respective metric results for all trained models.

The option to generate plots of the metric evaluation results is provided by setting the value of the parameter `plotting_config` to the name of the [plotting configuration](plotting_config) file, e.g. `plotting_config.yaml`. This will trigger WaveDiff's plotting pipeline to produce plots after completion of the metrics evaluation pipeline. If the field is left empty, no plots are generated.

To compute the errors of the trained PSF model, the `metrics` package can retrieve a ground truth data set if it exists in the dataset files listed in the [data_configuration](data_config) file. If they do exist, WaveDiff can generate at runtime a `ground truth model` using the parameters in the metrics configuration file associated to the key: `ground_truth_model`. The parameter settings for the ground truth model are similar to those contained in the [training configuration](training_config) file. Currently, the choice of model, which is indicated by the key `model_name`, is currently limited to the polychromatic PSF model, referenced by the short name `poly`.

@jeipollack
Copy link
Contributor Author

No. not from a commit state. You should add the links to the files in the main branch.

@jeipollack jeipollack linked a pull request Dec 13, 2023 that will close this issue
@jeipollack jeipollack linked a pull request Dec 15, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants