Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-20251

Improve documentation for how to register metrics with ap_verify

    XMLWordPrintable

Details

    • Improvement
    • Status: Done
    • Resolution: Done
    • None
    • ap_verify
    • None
    • 2
    • AP F19-3 (Skipped)
    • Alert Production

    Description

      ap_verify's metrics are configured using several MetricsControllerConfigs, but currently this fact is only documented in the command-line reference. Add clearer documentation (perhaps even a full tutorial), delegating to the verify documentation for the details of the actual configuration.

      Attachments

        Activity

          Also remove the phrase "defect files and" from the "Packaging data as a dataset" topic page.

          krzys Krzysztof Findeisen added a comment - Also remove the phrase "defect files and" from the "Packaging data as a dataset" topic page.

          Also add an "all the data" example (requested by Parejkoj).

          krzys Krzysztof Findeisen added a comment - Also add an "all the data" example (requested by Parejkoj ).
          krzys Krzysztof Findeisen added a comment - - edited

          Just noticed that the configs are already documented! Maybe I just need to move the existing page out of the "contributing" docs, and add the requested links...

          krzys Krzysztof Findeisen added a comment - - edited Just noticed that the configs are already documented ! Maybe I just need to move the existing page out of the "contributing" docs, and add the requested links...

          Hi mrawls, as a future metric-writer, can you take a look and let me know if the documentation is adequate, or whether I was too lazy in how I solved things?

          krzys Krzysztof Findeisen added a comment - Hi mrawls , as a future metric-writer, can you take a look and let me know if the documentation is adequate, or whether I was too lazy in how I solved things?

          Added a tar file with the built docs, in case it's useful.

          krzys Krzysztof Findeisen added a comment - Added a tar file with the built docs, in case it's useful.

          Finally looping back on this, thanks for your patience. It looks good, though I am not sure how useful the nominal examples you point to in lsst.verify.gen2tasks.MetricsControllerTask really are. I'll find out eventually, especially if things get gen-3-ified before I dive into metrics! Please see other small comments on GitHub.

          mrawls Meredith Rawls added a comment - Finally looping back on this, thanks for your patience. It looks good, though I am not sure how useful the nominal examples you point to in lsst.verify.gen2tasks.MetricsControllerTask  really are. I'll find out eventually, especially if things get gen-3-ified before I dive into metrics! Please see other small comments on GitHub.
          krzys Krzysztof Findeisen added a comment - - edited

          Thanks for the review! Though if we switch to Gen 3 first, that page and its examples will be obsolete.

          krzys Krzysztof Findeisen added a comment - - edited Thanks for the review! Though if we switch to Gen 3 first, that page and its examples will be obsolete.

          People

            krzys Krzysztof Findeisen
            krzys Krzysztof Findeisen
            Meredith Rawls
            Krzysztof Findeisen, Meredith Rawls
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Jenkins

                No builds found.