Pull request #30: Release/0.2.5

Merge in FO00039/thetis-public-github from release/0.2.5 to main

Author: tobiaslatka

docs/source/evaluation-aspects/uncertainty.rst

@@ -47,7 +47,7 @@ expectation of the difference between predicted confidence and observed accuracy
 
    \mathbb{E}_{\hat{P} \sim f_{\hat{P}}} \Big[ | \mathbb{P}(\hat{Y} = \bar{Y} | \hat{P} = \hat{p}) - \hat{p} | \Big].
 
-Since the expectation is given over a continuous distribution, it is directly tractable.
+Since the expectation is given over a continuous distribution, it isn't directly tractable.
 Instead, the ECE is an approximation of the expectation by applying a binning scheme over the confidence space.
 Each predicted sample is grouped into a bin by its confidence. Afterwards, we can compare the average accuracy with
 the average confidence within each bin to compute the *conditional* probability of correctness.

examples/classification.ipynb

@@ -234,6 +234,9 @@
     "description: dict[str, str]={\n",
     "    \"title\": \"Income Prediction (Demo)\",\n",
     "    \"issuer\": \"XYZ Demo Solutions GmbH\",\n",
+    "    \"risk_class\": \"High Risk\",\n",
+    "    \"useCase\": \"Income Prediction\",\n",
+    "    \"role\": \"User\",\n",
     "    \"contact_intern\": \"Jon Doe\",\n",
     "    \"contact_extern\": \"Jane Doe\",\n",
     "    \"purpose\": \"The goal of this AI system is to estimate, based on demographic data, whether a person's income ...\",\n",
@@ -251,29 +254,31 @@
    "cell_type": "code",
    "source": [
     "from thetis import thetis\n",
+    "from thetis import ThetisArgs\n",
     "\n",
-    "\n",
-    "result = thetis(\n",
+    "thetis_args = ThetisArgs(\n",
     "   config=\"demo_config_classification.yaml\",\n",
     "   description=description,\n",
     "   annotations=annotations,\n",
     "   predictions=predictions,\n",
     "   output_dir=\"./output\",\n",
     "   license_file_path=\"demo_license_classification.dat\"\n",
-    ")"
+    ")\n",
+    "\n",
+    "result = thetis(thetis_args)"
    ],
    "outputs": [],
    "execution_count": null
   },
   {
    "metadata": {},
    "cell_type": "code",
-   "outputs": [],
-   "execution_count": null,
    "source": [
     "from IPython.display import IFrame\n",
     "IFrame(\"./output/report.pdf\", width=800, height=1024)"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   }
  ],
  "metadata": {

examples/demo_license_classification.dat

@@ -1,6 +1,6 @@
 <LicenseKey>
   <Info>
-    <Id>15726922-d2ca-41a0-bc6f-e47554f25114</Id>
+    <Id>c0d70de5-a6a9-4f03-b99f-36e54ebd8cfe</Id>
     <Features>Thetis:classification Thetis:data_evaluation Thetis:performance Thetis:fairness Thetis:uncertainty Thetis:annotations:86992bcd3c2d58f85473ecff3cfbcd79</Features>
     <Licensee>
       <CompanyName>Thetis Classification Demo License</CompanyName>
@@ -21,13 +21,13 @@
       <City>Gaimersheim</City>
       <Country>Germany</Country>
     </Licenser>
-    <ExpiryDate>2025-12-31T00:00:00</ExpiryDate>
+    <ExpiryDate>2030-12-31T00:00:00</ExpiryDate>
     <Notes>
       <string>The terms of use for Thetis apply. The current version can be found at https://app.thetis.de/static/terms.</string>
     </Notes>
     <LicenseBinding />
     <Seats>1</Seats>
   </Info>
-  <Key>PExpY2Vuc2VJbmZvPg0KICA8SWQ+MTU3MjY5MjItZDJjYS00MWEwLWJjNmYtZTQ3NTU0ZjI1MTE0PC9JZD4NCiAgPEZlYXR1cmVzPlRoZXRpczpjbGFzc2lmaWNhdGlvbiBUaGV0aXM6ZGF0YV9ldmFsdWF0aW9uIFRoZXRpczpwZXJmb3JtYW5jZSBUaGV0aXM6ZmFpcm5lc3MgVGhldGlzOnVuY2VydGFpbnR5IFRoZXRpczphbm5vdGF0aW9uczo4Njk5MmJjZDNjMmQ1OGY4NTQ3M2VjZmYzY2ZiY2Q3OTwvRmVhdHVyZXM+DQogIDxMaWNlbnNlZT4NCiAgICA8Q29tcGFueU5hbWU+VGhldGlzIENsYXNzaWZpY2F0aW9uIERlbW8gTGljZW5zZTwvQ29tcGFueU5hbWU+DQogICAgPENvbnRhY3ROYW1lIC8+DQogICAgPEFkZHJlc3NMaW5lcz4NCiAgICAgIDxzdHJpbmcgLz4NCiAgICA8L0FkZHJlc3NMaW5lcz4NCiAgICA8UG9zdGFsQ29kZSAvPg0KICAgIDxDaXR5IC8+DQogICAgPENvdW50cnkgLz4NCiAgPC9MaWNlbnNlZT4NCiAgPExpY2Vuc2VyPg0KICAgIDxDb21wYW55TmFtZT5lOmZzIFRlY2hIdWIgR21iSDwvQ29tcGFueU5hbWU+DQogICAgPEFkZHJlc3NMaW5lcz4NCiAgICAgIDxzdHJpbmc+RHIuLUx1ZHdpZy1LcmF1cy1TdHIuIDY8L3N0cmluZz4NCiAgICA8L0FkZHJlc3NMaW5lcz4NCiAgICA8UG9zdGFsQ29kZT44NTA4MDwvUG9zdGFsQ29kZT4NCiAgICA8Q2l0eT5HYWltZXJzaGVpbTwvQ2l0eT4NCiAgICA8Q291bnRyeT5HZXJtYW55PC9Db3VudHJ5Pg0KICA8L0xpY2Vuc2VyPg0KICA8RXhwaXJ5RGF0ZT4yMDI1LTEyLTMxVDAwOjAwOjAwPC9FeHBpcnlEYXRlPg0KICA8Tm90ZXM+DQogICAgPHN0cmluZz5UaGUgdGVybXMgb2YgdXNlIGZvciBUaGV0aXMgYXBwbHkuIFRoZSBjdXJyZW50IHZlcnNpb24gY2FuIGJlIGZvdW5kIGF0IGh0dHBzOi8vYXBwLnRoZXRpcy5kZS9zdGF0aWMvdGVybXMuPC9zdHJpbmc+DQogIDwvTm90ZXM+DQogIDxMaWNlbnNlQmluZGluZyAvPg0KICA8U2VhdHM+MTwvU2VhdHM+DQo8L0xpY2Vuc2VJbmZvPg==</Key>
-  <Signature>e/hNQSPhjATgwrCs0nJTXJ0Ae9S6Kh/5KaXSYPZyIytDljU1kJHSMqsNT1pBUijEs38j2lcqnmhi2q8ssEUdnKx9HgUlK6PwIamUdT8h82H9gx/fa8PWK7LsNpRg10NHdVi9hfgkb7ll9lkAWp5QaU43ClYdjA0XtFT1555pygxsxr5z04gt7WnbuErXrh7kqcE00BzWgBydIo4b+IITq0wRUZQwPX83sgagrbr3uC9qILIyajVOawmcleMyfNilGH9IJvNxhxGvSGcYRXXTszhw8ozUdN2yZv8itn7RveIl7Jd4TuYIr+55YewCG0CWTzePCWICAg2+9HTMQmd1yr12qxCe6Tvk3Cfa2ADwwOYUPBK5kXGHXez2/wKaS8sfZglxkQ1kxpXxI5lflTUafXDXCl/o6r8NeIsuorD9N54CzXVGzphsGgCeDe6e7Nag0JtIZECeQSDnOZChNQhxFf79VY9QvQLrrNjdSeKSwA+s6fwmpujTj7qVUAFZOOf2A1U0qQnERqsp+tJVwnGNgJXqyhb9ZSrD+17nNEsiRUZVaZl3ASppve0jCazFVPcNhLjw/vzaDPKo9oHuuMqeDP2aVRFtSNafQfR1UcU3WFEmu/KcSfDlPjs5/FEMKK6aBSVGfbvXgAmb5sPIWfec+sGCJ/puzxPaDm7hPVQawkI=</Signature>
+  <Key>PExpY2Vuc2VJbmZvPg0KICA8SWQ+YzBkNzBkZTUtYTZhOS00ZjAzLWI5OWYtMzZlNTRlYmQ4Y2ZlPC9JZD4NCiAgPEZlYXR1cmVzPlRoZXRpczpjbGFzc2lmaWNhdGlvbiBUaGV0aXM6ZGF0YV9ldmFsdWF0aW9uIFRoZXRpczpwZXJmb3JtYW5jZSBUaGV0aXM6ZmFpcm5lc3MgVGhldGlzOnVuY2VydGFpbnR5IFRoZXRpczphbm5vdGF0aW9uczo4Njk5MmJjZDNjMmQ1OGY4NTQ3M2VjZmYzY2ZiY2Q3OTwvRmVhdHVyZXM+DQogIDxMaWNlbnNlZT4NCiAgICA8Q29tcGFueU5hbWU+VGhldGlzIENsYXNzaWZpY2F0aW9uIERlbW8gTGljZW5zZTwvQ29tcGFueU5hbWU+DQogICAgPENvbnRhY3ROYW1lIC8+DQogICAgPEFkZHJlc3NMaW5lcz4NCiAgICAgIDxzdHJpbmcgLz4NCiAgICA8L0FkZHJlc3NMaW5lcz4NCiAgICA8UG9zdGFsQ29kZSAvPg0KICAgIDxDaXR5IC8+DQogICAgPENvdW50cnkgLz4NCiAgPC9MaWNlbnNlZT4NCiAgPExpY2Vuc2VyPg0KICAgIDxDb21wYW55TmFtZT5lOmZzIFRlY2hIdWIgR21iSDwvQ29tcGFueU5hbWU+DQogICAgPEFkZHJlc3NMaW5lcz4NCiAgICAgIDxzdHJpbmc+RHIuLUx1ZHdpZy1LcmF1cy1TdHIuIDY8L3N0cmluZz4NCiAgICA8L0FkZHJlc3NMaW5lcz4NCiAgICA8UG9zdGFsQ29kZT44NTA4MDwvUG9zdGFsQ29kZT4NCiAgICA8Q2l0eT5HYWltZXJzaGVpbTwvQ2l0eT4NCiAgICA8Q291bnRyeT5HZXJtYW55PC9Db3VudHJ5Pg0KICA8L0xpY2Vuc2VyPg0KICA8RXhwaXJ5RGF0ZT4yMDMwLTEyLTMxVDAwOjAwOjAwPC9FeHBpcnlEYXRlPg0KICA8Tm90ZXM+DQogICAgPHN0cmluZz5UaGUgdGVybXMgb2YgdXNlIGZvciBUaGV0aXMgYXBwbHkuIFRoZSBjdXJyZW50IHZlcnNpb24gY2FuIGJlIGZvdW5kIGF0IGh0dHBzOi8vYXBwLnRoZXRpcy5kZS9zdGF0aWMvdGVybXMuPC9zdHJpbmc+DQogIDwvTm90ZXM+DQogIDxMaWNlbnNlQmluZGluZyAvPg0KICA8U2VhdHM+MTwvU2VhdHM+DQo8L0xpY2Vuc2VJbmZvPg==</Key>
+  <Signature>dLJZ0YTbC4GIYQ9Z3l6ckavw6nNe09eYYv8ZfF6jo7SY2G+DsO+/Q64zYeOV3FcX6ta4srinYLZ0CXBOxOxYoBNgmNdWi5z4YYynmAq0mTFcM4MeEZK+TpzWDpdXaLdJRqXCrBbEI+jaWwNeTNVjaz4qo8Gwc1ie3m3phLIf8lUXVnP3gBlfoRkvkDvJJksE+uGRPv2d95dQd+Vq4hb3ToV7bQXY5XvPI+jtMzSWjz1l4A8nUcic7J8ZppFdMl0E1QMPg3gETR4PCR0NiHmK7CgddaHkY74SrdISUKF9HAvT9puC7/aIqDAYp1EFZZcSZI7gkuodJYObjM8yncRQitPn3OrZDhemO7E6GwlWtv0R2JTykRxebeYxmJgcsvH33YDPDUMWjchmLrWwKnT2nZhufligLoxQPtnrBEjPvV7qLC/CxOxHNIL+8tlPdsQI0tvF5OPDaa4UDTUNyI6ArQ6H4+wh3KRkMNwbwt4/6hrLfhrkPASJXpiknFcIkKxwNlSlSFoSi6RBbdJieaNz6o6UejeE6AYPFvX9DIDQV4NZeQ4wEp1Y1o8XWgmnCEchiZHyOpw7O3efMaaXM7wLkoX5OmblDyHfhezgVjA/kMH7OtTX77015bY5KIywd46evxjooY3bR+9KLiSX7RSWNEUmuSmJ+AI5OWopE+Q6ZcM=</Signature>
 </LicenseKey>

examples/demo_license_detection.dat

@@ -1,6 +1,6 @@
 <LicenseKey>
   <Info>
-    <Id>d89e5123-6369-4594-8fc0-c2b5b638923c</Id>
+    <Id>16d3367d-def2-4914-91e1-b676ea8b8b31</Id>
     <Features>Thetis:detection Thetis:data_evaluation Thetis:performance Thetis:fairness Thetis:uncertainty Thetis:annotations:99f9f701bad4e5f9d6b9754fcf738e1b</Features>
     <Licensee>
       <CompanyName>Thetis Detection Demo License</CompanyName>
@@ -21,13 +21,13 @@
       <City>Gaimersheim</City>
       <Country>Germany</Country>
     </Licenser>
-    <ExpiryDate>2025-12-31T00:00:00</ExpiryDate>
+    <ExpiryDate>2030-12-31T00:00:00</ExpiryDate>
     <Notes>
       <string>The terms of use for Thetis apply. The current version can be found at https://app.thetis.de/static/terms.</string>
     </Notes>
     <LicenseBinding />
     <Seats>1</Seats>
   </Info>
-  <Key>PExpY2Vuc2VJbmZvPg0KICA8SWQ+ZDg5ZTUxMjMtNjM2OS00NTk0LThmYzAtYzJiNWI2Mzg5MjNjPC9JZD4NCiAgPEZlYXR1cmVzPlRoZXRpczpkZXRlY3Rpb24gVGhldGlzOmRhdGFfZXZhbHVhdGlvbiBUaGV0aXM6cGVyZm9ybWFuY2UgVGhldGlzOmZhaXJuZXNzIFRoZXRpczp1bmNlcnRhaW50eSBUaGV0aXM6YW5ub3RhdGlvbnM6OTlmOWY3MDFiYWQ0ZTVmOWQ2Yjk3NTRmY2Y3MzhlMWI8L0ZlYXR1cmVzPg0KICA8TGljZW5zZWU+DQogICAgPENvbXBhbnlOYW1lPlRoZXRpcyBEZXRlY3Rpb24gRGVtbyBMaWNlbnNlPC9Db21wYW55TmFtZT4NCiAgICA8Q29udGFjdE5hbWUgLz4NCiAgICA8QWRkcmVzc0xpbmVzPg0KICAgICAgPHN0cmluZyAvPg0KICAgIDwvQWRkcmVzc0xpbmVzPg0KICAgIDxQb3N0YWxDb2RlIC8+DQogICAgPENpdHkgLz4NCiAgICA8Q291bnRyeSAvPg0KICA8L0xpY2Vuc2VlPg0KICA8TGljZW5zZXI+DQogICAgPENvbXBhbnlOYW1lPmU6ZnMgVGVjaEh1YiBHbWJIPC9Db21wYW55TmFtZT4NCiAgICA8QWRkcmVzc0xpbmVzPg0KICAgICAgPHN0cmluZz5Eci4tTHVkd2lnLUtyYXVzLVN0ci4gNjwvc3RyaW5nPg0KICAgIDwvQWRkcmVzc0xpbmVzPg0KICAgIDxQb3N0YWxDb2RlPjg1MDgwPC9Qb3N0YWxDb2RlPg0KICAgIDxDaXR5PkdhaW1lcnNoZWltPC9DaXR5Pg0KICAgIDxDb3VudHJ5Pkdlcm1hbnk8L0NvdW50cnk+DQogIDwvTGljZW5zZXI+DQogIDxFeHBpcnlEYXRlPjIwMjUtMTItMzFUMDA6MDA6MDA8L0V4cGlyeURhdGU+DQogIDxOb3Rlcz4NCiAgICA8c3RyaW5nPlRoZSB0ZXJtcyBvZiB1c2UgZm9yIFRoZXRpcyBhcHBseS4gVGhlIGN1cnJlbnQgdmVyc2lvbiBjYW4gYmUgZm91bmQgYXQgaHR0cHM6Ly9hcHAudGhldGlzLmRlL3N0YXRpYy90ZXJtcy48L3N0cmluZz4NCiAgPC9Ob3Rlcz4NCiAgPExpY2Vuc2VCaW5kaW5nIC8+DQogIDxTZWF0cz4xPC9TZWF0cz4NCjwvTGljZW5zZUluZm8+</Key>
-  <Signature>MSYZ/A116KS7BxrOec96UnLV70oQTGlj4ZA0xmMqB3RaFSXF9eKNrRmd8iJAYPn6ExoawATJriTCL33nZdXuLsbD2OirKUjePYRRDMe2CiYQkCdvHD9TaN9SWBJcLCS1weDNTgyMp3Se+Hhwa3OUXpScFJVKqni4o1GlhBbxVwnrlAHn3fBAM33mgMs5oXUBaS1H9TXXmaDg+OMoy5RDxLBjck7o4UCN9ztvygt+u+94p/QMafqD/lX0/7GJc4dfLcwpaNyHKdB8jAPyMKYSYKEeqea31QsXefN4u9oEi6WxkWEihLHIUG/aF1iC7O/gRbOr0bXoO7qZ/P65/JNDKleary14qV+E9biuvKBHx43KD0pxUXYGn+CDfjvX/SVZZqns3GbpzV8oRRupIv/uMxgZyo1uzP/naI0kyVg62kqSnge34ZwnCW3Q0Ula5I/I931J18PKXhfV6E93MGZEvhSVKXPOnyDgR3P01rK5fPbWoXiQ3ymhloPHTFsPk55zcYZOJLlu+AgRVSzNmgclflUbTkzifmefemNrnymsg8ESVOl6R++ynHUZFfRoTpbYO4q5Y8VTJNTxCRzmVMsdxtw7KXLDmwnqw/eRhTTz2lN6tWK5QWnjT/ng4jijXIjyGwlyy4dY0dl9JhJc8+zsWpN8qfmpUXF/r107WBZFGUY=</Signature>
+  <Key>PExpY2Vuc2VJbmZvPg0KICA8SWQ+MTZkMzM2N2QtZGVmMi00OTE0LTkxZTEtYjY3NmVhOGI4YjMxPC9JZD4NCiAgPEZlYXR1cmVzPlRoZXRpczpkZXRlY3Rpb24gVGhldGlzOmRhdGFfZXZhbHVhdGlvbiBUaGV0aXM6cGVyZm9ybWFuY2UgVGhldGlzOmZhaXJuZXNzIFRoZXRpczp1bmNlcnRhaW50eSBUaGV0aXM6YW5ub3RhdGlvbnM6OTlmOWY3MDFiYWQ0ZTVmOWQ2Yjk3NTRmY2Y3MzhlMWI8L0ZlYXR1cmVzPg0KICA8TGljZW5zZWU+DQogICAgPENvbXBhbnlOYW1lPlRoZXRpcyBEZXRlY3Rpb24gRGVtbyBMaWNlbnNlPC9Db21wYW55TmFtZT4NCiAgICA8Q29udGFjdE5hbWUgLz4NCiAgICA8QWRkcmVzc0xpbmVzPg0KICAgICAgPHN0cmluZyAvPg0KICAgIDwvQWRkcmVzc0xpbmVzPg0KICAgIDxQb3N0YWxDb2RlIC8+DQogICAgPENpdHkgLz4NCiAgICA8Q291bnRyeSAvPg0KICA8L0xpY2Vuc2VlPg0KICA8TGljZW5zZXI+DQogICAgPENvbXBhbnlOYW1lPmU6ZnMgVGVjaEh1YiBHbWJIPC9Db21wYW55TmFtZT4NCiAgICA8QWRkcmVzc0xpbmVzPg0KICAgICAgPHN0cmluZz5Eci4tTHVkd2lnLUtyYXVzLVN0ci4gNjwvc3RyaW5nPg0KICAgIDwvQWRkcmVzc0xpbmVzPg0KICAgIDxQb3N0YWxDb2RlPjg1MDgwPC9Qb3N0YWxDb2RlPg0KICAgIDxDaXR5PkdhaW1lcnNoZWltPC9DaXR5Pg0KICAgIDxDb3VudHJ5Pkdlcm1hbnk8L0NvdW50cnk+DQogIDwvTGljZW5zZXI+DQogIDxFeHBpcnlEYXRlPjIwMzAtMTItMzFUMDA6MDA6MDA8L0V4cGlyeURhdGU+DQogIDxOb3Rlcz4NCiAgICA8c3RyaW5nPlRoZSB0ZXJtcyBvZiB1c2UgZm9yIFRoZXRpcyBhcHBseS4gVGhlIGN1cnJlbnQgdmVyc2lvbiBjYW4gYmUgZm91bmQgYXQgaHR0cHM6Ly9hcHAudGhldGlzLmRlL3N0YXRpYy90ZXJtcy48L3N0cmluZz4NCiAgPC9Ob3Rlcz4NCiAgPExpY2Vuc2VCaW5kaW5nIC8+DQogIDxTZWF0cz4xPC9TZWF0cz4NCjwvTGljZW5zZUluZm8+</Key>
+  <Signature>i2JO580juo9DnPTZPlaQtZ4zBOVAmiOLw81hinKVXXPImH2HHWU7YTEnoJgqwi/XPezms2o4IYlqC9ISOl2zMOAOseWIjnlKTWtDv4jdtJrC+gySQQNRq3mcq7noIJ2aZYLw42EM8S6j7fTqa9SCO3lwLGJxK3P1Po9ULZ3g7bwjWk0daHgmjrlai/isTHpmagJLzcPf46W3M6mzc+DXLgh+1yAtMajeQyj0oilSLJXVej+zgdNf3RMq3qLKHqAuVUnFes7Xzpj6zptgvu/Z6VCODIxgMv/5QwOveKTiov0fUHiuBv5Tc8FaokFcgtymuAVUCgIIWb9YlqYRx4wZ5pO5bspPCQoIqbDMGeTcFpvEUeWovp3yQ5L/fHzk16k3ud3rpuHsWObdLxqdz4MdeJcakvdwkZBBIAdMR3Ae/l7AYfCEc/TVpbsz54bWAkaQcD/2ZCfcb9S4T1Zd9ELOdeVKjQeHhgtQiXyypUhggZmE9Dk1pVEzfe1tDRl5t8yv9KOcFgYZkgJyuUoE8Z/MmCO9m/3ltVm51KZXGRDlOXB1zEvuhtw00wTFh9DNChm4/Svh04HVp5ZvWdX763HNF8MXr6jKtMyUIA51DYoUG5bmyXZOLL18Re1/fjsJOI6naHPwC0ccbf9hyuraQTp3tJSikB9AZA7oCf3SiuIOszg=</Signature>
 </LicenseKey>

examples/demo_license_regression.dat

@@ -1,6 +1,6 @@
 <LicenseKey>
   <Info>
-    <Id>30481127-0ebd-4f48-84cb-826ffb780826</Id>
+    <Id>c450c3a9-c905-4d50-b897-8ccdf98381b5</Id>
     <Features>Thetis:regression Thetis:data_evaluation Thetis:performance Thetis:fairness Thetis:uncertainty Thetis:annotations:cd1a4378f81b4575e6e89b09bef17661</Features>
     <Licensee>
       <CompanyName>Thetis Regression Demo License</CompanyName>
@@ -21,13 +21,13 @@
       <City>Gaimersheim</City>
       <Country>Germany</Country>
     </Licenser>
-    <ExpiryDate>2025-12-31T00:00:00</ExpiryDate>
+    <ExpiryDate>2030-12-31T00:00:00</ExpiryDate>
     <Notes>
       <string>The terms of use for Thetis apply. The current version can be found at https://app.thetis.de/static/terms.</string>
     </Notes>
     <LicenseBinding />
     <Seats>1</Seats>
   </Info>
-  <Key>PExpY2Vuc2VJbmZvPg0KICA8SWQ+MzA0ODExMjctMGViZC00ZjQ4LTg0Y2ItODI2ZmZiNzgwODI2PC9JZD4NCiAgPEZlYXR1cmVzPlRoZXRpczpyZWdyZXNzaW9uIFRoZXRpczpkYXRhX2V2YWx1YXRpb24gVGhldGlzOnBlcmZvcm1hbmNlIFRoZXRpczpmYWlybmVzcyBUaGV0aXM6dW5jZXJ0YWludHkgVGhldGlzOmFubm90YXRpb25zOmNkMWE0Mzc4ZjgxYjQ1NzVlNmU4OWIwOWJlZjE3NjYxPC9GZWF0dXJlcz4NCiAgPExpY2Vuc2VlPg0KICAgIDxDb21wYW55TmFtZT5UaGV0aXMgUmVncmVzc2lvbiBEZW1vIExpY2Vuc2U8L0NvbXBhbnlOYW1lPg0KICAgIDxDb250YWN0TmFtZSAvPg0KICAgIDxBZGRyZXNzTGluZXM+DQogICAgICA8c3RyaW5nIC8+DQogICAgPC9BZGRyZXNzTGluZXM+DQogICAgPFBvc3RhbENvZGUgLz4NCiAgICA8Q2l0eSAvPg0KICAgIDxDb3VudHJ5IC8+DQogIDwvTGljZW5zZWU+DQogIDxMaWNlbnNlcj4NCiAgICA8Q29tcGFueU5hbWU+ZTpmcyBUZWNoSHViIEdtYkg8L0NvbXBhbnlOYW1lPg0KICAgIDxBZGRyZXNzTGluZXM+DQogICAgICA8c3RyaW5nPkRyLi1MdWR3aWctS3JhdXMtU3RyLiA2PC9zdHJpbmc+DQogICAgPC9BZGRyZXNzTGluZXM+DQogICAgPFBvc3RhbENvZGU+ODUwODA8L1Bvc3RhbENvZGU+DQogICAgPENpdHk+R2FpbWVyc2hlaW08L0NpdHk+DQogICAgPENvdW50cnk+R2VybWFueTwvQ291bnRyeT4NCiAgPC9MaWNlbnNlcj4NCiAgPEV4cGlyeURhdGU+MjAyNS0xMi0zMVQwMDowMDowMDwvRXhwaXJ5RGF0ZT4NCiAgPE5vdGVzPg0KICAgIDxzdHJpbmc+VGhlIHRlcm1zIG9mIHVzZSBmb3IgVGhldGlzIGFwcGx5LiBUaGUgY3VycmVudCB2ZXJzaW9uIGNhbiBiZSBmb3VuZCBhdCBodHRwczovL2FwcC50aGV0aXMuZGUvc3RhdGljL3Rlcm1zLjwvc3RyaW5nPg0KICA8L05vdGVzPg0KICA8TGljZW5zZUJpbmRpbmcgLz4NCiAgPFNlYXRzPjE8L1NlYXRzPg0KPC9MaWNlbnNlSW5mbz4=</Key>
-  <Signature>a270BQHJFTeuumlxKGEuJ54lFDY4F4pxkTEh9DFCqTBc2MJ3YZrUAp99ZQ94jPQ8VEOCq9rFBdg1BxTOSp59CSUVlLwwRdegcHu25OhIxNtyUkyAdIwU1S3wo+44Him8lXSmZsVFDR8/1BovY4HOSFIihVjWc8Oq63Nx6gNTbAoZxyapdPYtB9OsYLOHh8gnJmxXIkrF6tcUol9hu0y6+Uwo53iAI1LHV2BPBXivcysqfv5jNMJ67Cd5gg+zcbzXFF7qXI691Ld/k44i4RNngMdLuMrcFAx66QJsnX8JF4xlKmDrZ7+aj7ha3q4FaCEPBtviXfTtsPhGOu0PtDLS3ercV7rqrq4dg9Y2TnnI0ErHjhe2WLN0hvI2z9M7ZntCjFOAuSFoLpe/7rSf9WR6n2bTtjqHAawgjpi0xOu55QdmBcBdzWf6T9i2nNBY50upTmB7lJktoygOosaD+Lzqa5t7Hr4y6C9aXJaO2GEKM33KYLPl76k1iCWQ/1uWAMwjUhTtIG9UUa9v6cfdEufSUrH04nht0NVoYeLmQuJc7eo80jfp9qEYjiYEb8ecZozJAq5xEt68Gwh36ZSkIHuQ2XoZ20chOIblycHnmhdmKDwq8bgzqLKnfZJ9qR8V5Mnojq/kmZtD+MQUZjD7ExzrqbcuOagssebNhzZEC0bXZSg=</Signature>
+  <Key>PExpY2Vuc2VJbmZvPg0KICA8SWQ+YzQ1MGMzYTktYzkwNS00ZDUwLWI4OTctOGNjZGY5ODM4MWI1PC9JZD4NCiAgPEZlYXR1cmVzPlRoZXRpczpyZWdyZXNzaW9uIFRoZXRpczpkYXRhX2V2YWx1YXRpb24gVGhldGlzOnBlcmZvcm1hbmNlIFRoZXRpczpmYWlybmVzcyBUaGV0aXM6dW5jZXJ0YWludHkgVGhldGlzOmFubm90YXRpb25zOmNkMWE0Mzc4ZjgxYjQ1NzVlNmU4OWIwOWJlZjE3NjYxPC9GZWF0dXJlcz4NCiAgPExpY2Vuc2VlPg0KICAgIDxDb21wYW55TmFtZT5UaGV0aXMgUmVncmVzc2lvbiBEZW1vIExpY2Vuc2U8L0NvbXBhbnlOYW1lPg0KICAgIDxDb250YWN0TmFtZSAvPg0KICAgIDxBZGRyZXNzTGluZXM+DQogICAgICA8c3RyaW5nIC8+DQogICAgPC9BZGRyZXNzTGluZXM+DQogICAgPFBvc3RhbENvZGUgLz4NCiAgICA8Q2l0eSAvPg0KICAgIDxDb3VudHJ5IC8+DQogIDwvTGljZW5zZWU+DQogIDxMaWNlbnNlcj4NCiAgICA8Q29tcGFueU5hbWU+ZTpmcyBUZWNoSHViIEdtYkg8L0NvbXBhbnlOYW1lPg0KICAgIDxBZGRyZXNzTGluZXM+DQogICAgICA8c3RyaW5nPkRyLi1MdWR3aWctS3JhdXMtU3RyLiA2PC9zdHJpbmc+DQogICAgPC9BZGRyZXNzTGluZXM+DQogICAgPFBvc3RhbENvZGU+ODUwODA8L1Bvc3RhbENvZGU+DQogICAgPENpdHk+R2FpbWVyc2hlaW08L0NpdHk+DQogICAgPENvdW50cnk+R2VybWFueTwvQ291bnRyeT4NCiAgPC9MaWNlbnNlcj4NCiAgPEV4cGlyeURhdGU+MjAzMC0xMi0zMVQwMDowMDowMDwvRXhwaXJ5RGF0ZT4NCiAgPE5vdGVzPg0KICAgIDxzdHJpbmc+VGhlIHRlcm1zIG9mIHVzZSBmb3IgVGhldGlzIGFwcGx5LiBUaGUgY3VycmVudCB2ZXJzaW9uIGNhbiBiZSBmb3VuZCBhdCBodHRwczovL2FwcC50aGV0aXMuZGUvc3RhdGljL3Rlcm1zLjwvc3RyaW5nPg0KICA8L05vdGVzPg0KICA8TGljZW5zZUJpbmRpbmcgLz4NCiAgPFNlYXRzPjE8L1NlYXRzPg0KPC9MaWNlbnNlSW5mbz4=</Key>
+  <Signature>i9hiK9BRLrsiB0xQXA3Hn9v+CVRiHsrAbzYBiPRpMPeXng1I8orR9joj7bH/lycX9OyIUJDp4NyX1f0GAKHAvpZYcUfErsU2CbxqUFEIZsAk33ohWjLdE3kGxKodaROgjYxNSLV51M+h9rwbtYj8+D7SBU1Px8SoMi9uBYpqM5h4q8CPRcNHC7CfSVYOokE5slYpqkxoICyV/STKLMAgBgua1TDO2203+ykQd+cSmNzoPE6qGl3uPqJLh3MU2nb5gi9JGszz5TYZH5tZ9KWfn0Ipjq3ZVg8Tjdmc0NwLp63wocWMHw54XgAa+27UEP3WIou5PAW7soMwoAExlKy/ojq9i+TLeg2e/GGq104+IEZaSo+8Cv6bHT5lQGSgdSfA2oz80cmXXHeKPfgRMGtE0z87568aEaE8YfNPWVXqIFSkIIa7Z8TDrHRfkcc4pN6kgjmfkpsGiBa1UqQJrTDUndjxH3I5W7P7clTl5EteOSvpzm4Se3bQIxZtgHdn9QY8G4AFS2PC8mMIQixUR3hiCLghEyX96r/9iXXcEZgRs0GMUCgtnST/GJ4VUerS/MFLjaSDX4Gy/fB2Ox/UPDz525J2JmDhpUdm15uLKakmOKbP44dikHLNFhCS2ujrPjhE5K5KkNQ+CwVmngHc6mX5o5fY4VTDTXPrhF8+IsRUJ0g=</Signature>
 </LicenseKey>

examples/detection.ipynb

@@ -83,7 +83,7 @@
   {
    "metadata": {},
    "cell_type": "code",
-   "source": "!pip install torchvision",
+   "source": "pip install torchvision",
    "outputs": [],
    "execution_count": null
   },
@@ -303,6 +303,9 @@
     "description: dict[str, str]={\n",
     "    \"title\": \"Object Detection (Demo)\",\n",
     "    \"issuer\": \"XYZ Demo Solutions GmbH\",\n",
+    "    \"risk_class\": \"High Risk\",\n",
+    "    \"useCase\": \"Object Detection\",\n",
+    "    \"role\": \"Provider\",\n",
     "    \"contact_intern\": \"Jon Doe\",\n",
     "    \"contact_extern\": \"Jane Doe\",\n",
     "    \"purpose\": \"The goal of this AI system is, based on sensitive attributes like gender, age, etc., to detect objects in images ...\",\n",
@@ -320,16 +323,18 @@
    "metadata": {},
    "source": [
     "from thetis import thetis\n",
+    "from thetis import ThetisArgs\n",
     "\n",
-    "\n",
-    "result = thetis(\n",
+    "thetis_args = ThetisArgs(\n",
     "   config=\"demo_config_detection.yaml\",\n",
     "   description=description,\n",
     "   annotations=annotations,\n",
     "   predictions=predictions,\n",
     "   output_dir=\"./output\",\n",
     "   license_file_path=\"demo_license_detection.dat\"\n",
-    ")"
+    ")\n",
+    "\n",
+    "result = thetis(thetis_args)"
    ],
    "outputs": [],
    "execution_count": null

examples/regression.ipynb

@@ -226,6 +226,9 @@
     "description: dict[str, str]={\n",
     "    \"title\": \"Net Worth / Asset Score Prediction (Demo)\",\n",
     "    \"issuer\": \"XYZ Demo Solutions GmbH\",\n",
+    "    \"risk_class\": \"High Risk\",\n",
+    "    \"useCase\": \"Net Worth / Asset Score Prediction\",\n",
+    "    \"role\": \"User\",\n",
     "    \"contact_intern\": \"Jon Doe\",\n",
     "    \"contact_extern\": \"Jane Doe\",\n",
     "    \"purpose\": \"The goal of this AI system is to estimate, based on sensitive attributes like gender and age, a person's net worth ...\",\n",
@@ -243,15 +246,18 @@
    "metadata": {},
    "source": [
     "from thetis import thetis\n",
+    "from thetis import ThetisArgs\n",
     "\n",
-    "result = thetis(\n",
+    "thetis_args = ThetisArgs(\n",
     "   config=\"demo_config_regression.yaml\",\n",
     "   description=description,\n",
     "   annotations=annotations_test,\n",
     "   predictions=predictions,\n",
     "   output_dir=\"./output\",\n",
     "   license_file_path=\"demo_license_regression.dat\"\n",
-    ")"
+    ")\n",
+    "\n",
+    "result = thetis(thetis_args)"
    ],
    "outputs": [],
    "execution_count": null

requirements.txt

@@ -1 +1 @@
-thetiscore==0.2.4
+thetiscore==0.2.5

thetis/__init__.py

@@ -21,7 +21,8 @@
 from .io import write_json_with_pandas
 
 from .service import thetis
+from .service import ThetisArgs
 from .mlflow import thetis_mlflow
 
 name = "thetis"
-__version__ = "0.2.4"
+__version__ = "0.2.5"