From 7b584d41ae866813f09cf465513c7d3cab8e392c Mon Sep 17 00:00:00 2001 From: Rui Vieira Date: Mon, 11 Dec 2023 23:12:02 +0000 Subject: [PATCH] Add Python TrustyAI library and update documentation --- docs/modules/ROOT/pages/python-trustyai.adoc | 18 +++++++++++++++++- docs/modules/ROOT/pages/trustyai-core.adoc | 4 +++- docs/modules/ROOT/pages/trustyai-operator.adoc | 6 +++++- docs/modules/ROOT/pages/trustyai-service.adoc | 10 ++++++++++ 4 files changed, 35 insertions(+), 3 deletions(-) diff --git a/docs/modules/ROOT/pages/python-trustyai.adoc b/docs/modules/ROOT/pages/python-trustyai.adoc index 8fe0872..021cb7c 100644 --- a/docs/modules/ROOT/pages/python-trustyai.adoc +++ b/docs/modules/ROOT/pages/python-trustyai.adoc @@ -1 +1,17 @@ -= Python TrustyAI \ No newline at end of file += Python TrustyAI + +Python TrustyAI is a Python library for explainable AI. It is a wrapper around the xref:trustyai-core.adoc[TrustyAI core] explainability library. + +== Setup + +The library is available on PyPi and can be installed with pip. + +```bash +pip install trustyai +``` + +To install additional experimental features, the following command can be used: + +```bash +pip install trustyai[extras] +``` \ No newline at end of file diff --git a/docs/modules/ROOT/pages/trustyai-core.adoc b/docs/modules/ROOT/pages/trustyai-core.adoc index 7657aa6..385e598 100644 --- a/docs/modules/ROOT/pages/trustyai-core.adoc +++ b/docs/modules/ROOT/pages/trustyai-core.adoc @@ -1 +1,3 @@ -= TrustyAI core \ No newline at end of file += TrustyAI core + +The TrustyAI core is a Java library that provides the core functionality of the TrustyAI framework. It is used by the xref:trustyai-service.adoc[TrustyAI service] and the xref:python-trustyai.adoc[Python TrustyAI library]. \ No newline at end of file diff --git a/docs/modules/ROOT/pages/trustyai-operator.adoc b/docs/modules/ROOT/pages/trustyai-operator.adoc index cabb194..e3e5ad7 100644 --- a/docs/modules/ROOT/pages/trustyai-operator.adoc +++ b/docs/modules/ROOT/pages/trustyai-operator.adoc @@ -1 +1,5 @@ -= TrustyAI operator \ No newline at end of file += TrustyAI operator + +The TrustyAI Kubernetes Operator aims at simplifying the deployment and management of the xref:trustyai-service.adoc[TrustyAI service] on Kubernetes and OpenShift clusters by watching for custom resources of kind `TrustyAIService` in the `trustyai.opendatahub.io` API group and manages deployments, services, and optionally, routes and `ServiceMonitors` corresponding to these resources. + +The operator ensures the service is properly configured, is discoverable by Prometheus for metrics scraping (on both Kubernetes and OpenShift), and is accessible via a `Route` on OpenShift. \ No newline at end of file diff --git a/docs/modules/ROOT/pages/trustyai-service.adoc b/docs/modules/ROOT/pages/trustyai-service.adoc index bcff23c..d4b29a9 100644 --- a/docs/modules/ROOT/pages/trustyai-service.adoc +++ b/docs/modules/ROOT/pages/trustyai-service.adoc @@ -1,5 +1,15 @@ = TrustyAI service +The TrustyAI service is a REST service that provides the integration between XAI and metrics algorithms provided by the xref:trustyai-core.adoc[TrustyAI core] and external models. + +[NOTE] +==== +Although it can be used as a standalone service, it is designed to be used as part of Open Data Hub, deployed in OpenShift/Kubernetes and managed by the xref:trustyai-operator.adoc[TrustyAI operator]. +==== + +The main functionality of the service is to provide a REST API to calculate metrics and explainability. The service can consume model data (inputs and outputs) for metrics calculation either via a consumer endpoint, or cloud events. + +To provide explanations, the service performs inferences to a ModelMesh/KServe-deployed model using gRPC. == External endpoints