Klarity

Appearance

Klarity Viewer ​

Klarity Viewer is a web applicatio which purpose is to enable the manipulation and visualisation of PCIVs, starting with the artefacts they contain, before they are sent to the Klarity Dashboard.

Roles ​

Anyone who needs to manipulate artefacts and metrics before they are pushed into a PCIV on Klarity Dashboard will have a use of Klarity Viewer. Most of the time it will be :

  • AI Developer
  • AI Team Leader

Capacities ​

This section contains the high-level capacities expectations for Klarity Viewer.

** Configuration**

A configuration file defines the what artefacts are expected for each of the stages in the Klarity life-cycle of an AI component.

  1. I can navigate and visualize a template configuration file so I can understand what is expected for this configuration

    • A. I can see the hierarchy of groups and artefact which is defined by the configuration so I can easily understand its organization
    • B. I can select different stages of a template configuration file so I can see what is expected for each stage of this configuration.

  2. I can edit the configuration hierarchy so I can :

    • A. add, remove or modify the expected groups to be displayed at each stage for each abstraction level,
    • B. add, remove or modify the validation rules,
    • C. add, remove or modify the metrics contained in each group : name, scope, description, configuration...

    Any modification will propagate to all other instances of the artefacts throught the project.

  3. I can visualize an artefact payload in the same way as it will be displayed on KD so I can preview what I will push before it is actually pushed for validation.

  4. I can visualize the whole PCIV payload in the same way as it will be displayed on KD, including the groups.

  5. I can generate an artefact payload template for any artefact type that will just be to be filled with data from KC

To be discussed

  1. I can visualize the content of an artefact payload in realtime as I wont have to push or load or do anything on KV to see the updated display

Usage ​

  1. Load a configuration file template (visual inspection blueprint)
  2. Navigate the configuration and check the expectations (groups, artefacts) for each stage and level
  3. Customize what can be customized in the configuration file
    • description of the artefacts
    • new artefact
    • tbd
  4. Associate local data to artefact payload (?)

    How do we link with KC ?

  5. Check the display
  6. Adapt what can be adapted (?)

    we must formaly define what can be customized, changed, etc. we wont allow the user to modify the data to look good, yet it will have some abiliies to highlight elements, configure display, and so on.

Design ​

  1. Using KC I generate a working environment from a blueprint template.
  2. I open this environment with KV and navigate (usage step 1 & step 2)
  3. I update customizable elements
  4. Using WB I generate data, KC will make them available to KV.
  5. once i am okay with the data and the way it is displayed, i can push the pciv to KD (with KC/KV TBD)