Klarity

Appearance

Return On investment ​

Return on Investment artefact is used to forecast and verify the Return on Investment of the AI Component.

Configuration ​

Configuration used only in Scoping

JSON
   ./config.json
   
   "metrics": [
    {
      "name":  "ROI", "scope": "model","type":  "operation_roi","title": "Return on Investment", 
      "description": ".....",  "tooltip": "Return on Investment",
      "config": {"type":""}
    },

Payload ​

JSON

    ./payload.json

    {
        "metricName": "ROI",
        "values": {
            "project": url to html file,
            "inDepth": url to html file
        }
    }

Scoping Representations ​

Company level representation ​

Depending on the type, the company representation shall indicate this is an information or a question related artefact.

Information: alt text

Question: alt text

Project level representation - InDepth level representation ​

Under development Alt text

Configuration ​

Configuration used in Development and Operation

JSON
   ./config.json
   
   "metrics": [
    {
            "name": "OPERATION_ROI",
            "scope": "dataset",
            "type": "operation_roi",
            "title": "Test operation roi",
            "description": "La description de operation_roi",
            "tooltip": "Tooltip operation roi",
            "config": {
                "colors": {
                    "perf_gain": "#9ad0f5",
                    "op_gain": "#90EE90",
                    "other_gain": "#F6B26B",
                    "hr_gain": "#BF55EC",
                    "op_loss": "#FFD700",
                    "hr_loss": "#FF9999",
                    "perf_loss": "#FF69B4",
                    "other_loss": "#A9A9A9"
                },
                "epoch_scale": "day"
            }
        }
   ]

Payload ​

JSON

    ./payload.json

    {
            "metricName": "OPERATION_ROI",
            "values": {
                "series": {
                    "op_gain": 0,
                    "perf_gain": 38866.56,
                    "other_gain": 0,
                    "hr_gain": 14620.8,
                    "op_loss": -5000,
                    "hr_loss": 0,
                    "perf_loss": 0,
                    "other_loss": 0
                },
                "expectedROIValues": 85820
            }
        }

Development Representations ​

Company level representation ​

The company level should provide a synthetic overview of the project status, including overall performance indicators. It should present information that allows you to quickly identify any issues.

Detailed data, such as Return On Investement , are meant for in-depth views and therefore do not belong in the company level

Project level representation - InDepth level representation ​

Under development Alt text

Operation Representations ​

Company level representation ​

The same as the company Level in Development

Project level representation ​

alt text

InDepth level representation ​

alt text