From 8c32fd21080beead600b99480cc2f1fe78f14424 Mon Sep 17 00:00:00 2001 From: paoloyx Date: Fri, 21 Jun 2024 17:18:55 +0200 Subject: [PATCH 1/2] docs: remove typos in quickstart --- docs/docs/user-guide/quickstart.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/user-guide/quickstart.md b/docs/docs/user-guide/quickstart.md index ace01a16..9a8ae861 100644 --- a/docs/docs/user-guide/quickstart.md +++ b/docs/docs/user-guide/quickstart.md @@ -26,7 +26,7 @@ To use the radicalbit-ai-monitoring platform, you need first to prepare your dat This tutorial involves batch monitoring, including the situation where you have some historical data that you want to compare over time. -The **reference dataset** is the name we use to indicate the batch that contains the information we desire to have constantly (or we expect to have) over time. It could be the training set or a chunck of production data where the model has had good performances. +The **reference dataset** is the name we use to indicate the batch that contains the information we desire to have constantly (or we expect to have) over time. It could be the training set or a chunk of production data where the model has had good performances. The **current dataset** is the name we use to indicate the batch that contains fresh information, for example, the most recent production data, predictions or ground truths. We expect that it has the same characteristics (statistical properties) as the reference, which indicates that the model has the performance we expect and there is no drift in the data. @@ -34,7 +34,7 @@ What follows is an exemple of data we will use in this tutorial: | timestamp | user_id | question | model_answer | ground_truth | prediction | gender | age | device | days_as_customer | |-----------|--------:|:---------|:-------------|-------------:|-----------:|:-------|----:|:-------|-----------------:| -|2024-01-11 08:08:00|user_24:|What documents do I need to open a business account?|You need a valid ID, proof of address, and business registration documents.|1|1|M|44|smartphone|194| +|2024-01-11 08:08:00|user_24|What documents do I need to open a business account?|You need a valid ID, proof of address, and business registration documents.|1|1|M|44|smartphone|194| |2024-01-10 03:08:00|user_27|What are the benefits of a premium account?|The benefits of a premium account include higher interest rates and exclusive customer support.|1|1|F|29|tablet|258| 2024-01-11 12:22:00|user_56|How can I check my credit score?|You can check your credit score for free through our mobile app.|1|1|F|44|smartphone|51| 2024-01-10 04:57:00|user_58|Are there any fees for using ATMs?|ATM usage is free of charge at all locations.|1|1|M|50|smartphone|197| From 9eaf49dc2c0179d9d5c12fd9a99cb5d5156ae3a2 Mon Sep 17 00:00:00 2001 From: paoloyx Date: Fri, 21 Jun 2024 17:20:39 +0200 Subject: [PATCH 2/2] docs: update references to k3s --- README.md | 8 ++++---- docs/docs/user-guide/installation.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3da065e1..d1962b70 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ This repository contains all the files and projects to run Radicalbit AI Monitor ## 🚀 Installation using Docker compose -In this repository a docker compose file is available to run the platform in local with a k3s cluster where we can deploy Spark jobs. +In this repository a docker compose file is available to run the platform in local with a K3s cluster where we can deploy Spark jobs. To run, simply: @@ -50,9 +50,9 @@ docker compose --profile ui up After all containers are up & running, you can go to [http://localhost:5173](http://127.0.0.1:5173) to play with the app. -### Interacting with k3s cluster +### Interacting with K3s cluster -In the compose file is present a [k9s](https://k9scli.io/) container that can be used to monitor the k3s cluster. +In the compose file is present a [k9s](https://k9scli.io/) container that can be used to monitor the K3s cluster. ```bash docker compose up k9s -d && docker attach radicalbit-ai-monitoring-k9s-1 @@ -60,7 +60,7 @@ docker compose up k9s -d && docker attach radicalbit-ai-monitoring-k9s-1 #### Other tools -In order to connect and interact with the k3s cluster from the local machine (for example with Lens or `kubectl`) is necessary to create another file starting from `./docker/k3s_data/kubeconfig/kubeconfig.yaml` (that is automatically generated when the docker compose is up and running). +In order to connect and interact with the K3s cluster from the local machine (for example with Lens or `kubectl`) is necessary to create another file starting from `./docker/k3s_data/kubeconfig/kubeconfig.yaml` (that is automatically generated when the docker compose is up and running). Copy the above file and modify `https://k3s:6443` with `https://127.0.0.1:6443` and use this new file to interact with the cluster from the local machine diff --git a/docs/docs/user-guide/installation.md b/docs/docs/user-guide/installation.md index 8a6e7f7b..27e55eb4 100644 --- a/docs/docs/user-guide/installation.md +++ b/docs/docs/user-guide/installation.md @@ -24,7 +24,7 @@ Once you've installed Docker and Docker Compose, clone the repository to your lo git clone git@github.com:radicalbit/radicalbit-ai-monitoring.git ``` -This repository provides a Docker Compose file to set up the platform locally alongside a Rancher Kubernetes cluster. This allows you to deploy Spark jobs within the cluster. +This repository provides a Docker Compose file to set up the platform locally alongside a K3s Kubernetes cluster. This allows you to deploy Spark jobs within the cluster. For streamlined development and testing, you can execute these steps to run the platform locally without the graphical user interface: @@ -43,7 +43,7 @@ After all containers are up and running, you can access the platform at [http:// #### Accessing the Kubernetes Cluster The platform creates a Kubernetes cluster for managing deployments. You can connect and interact with this cluster from your local machine using tools like Lens or `kubectl`. -In the compose file is present a [k9s](https://k9scli.io/) container that can be used to monitor the k3s cluster. +In the compose file is present a [k9s](https://k9scli.io/) container that can be used to monitor the K3s cluster. ```bash docker compose up k9s -d && docker attach radicalbit-ai-monitoring-k9s-1