Skip to content

Commit 589c0c9

Browse files
committed
🤝 Fix typos in docs
1 parent de0a759 commit 589c0c9

File tree

7 files changed

+14
-14
lines changed

7 files changed

+14
-14
lines changed

docs/mkdocs/docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616

1717
**Source Code**: <a href="https://github.com/squaredev-io/whitebox" target="_blank">https://github.com/squaredev-io/whitebox</a>
1818

19-
**Roadmap**: <a href="https://github.com/squaredev-io/whitebox/milestone/2" target="_blank">https://github.com/squaredev-io/whitebox/milestone/2</a>
19+
**Roadmap**: <a href="https://github.com/squaredev-io/whitebox/milestones" target="_blank">https://github.com/squaredev-io/whitebox/milestones</a>
2020

2121
---
2222

23-
Whitebox is an dynamic open source E2E ML monitoring platform with edge capabilities that plays nicely with kubernetes.
23+
Whitebox is a dynamic open source E2E ML monitoring platform with edge capabilities that plays nicely with kubernetes.
2424

2525
The current key features are:
2626

docs/mkdocs/docs/metric-definitions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Glossary / Metric Definitions
1+
# Glossary / Metric definitions
22

33
## Descriptive statistics
44

@@ -203,7 +203,7 @@ where:
203203
- $P,Q$ = distributions of 2 datasets
204204
- $M$ = ${1 \over 2} * (P+Q)$
205205

206-
## Machine Learning models
206+
## Machine learning models
207207

208208
### Light Gradient Boosting Machine
209209

docs/mkdocs/docs/ml-monitoring.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
# Understanding Machine Learning Monitoring
1+
# Understanding machine learning monitoring
22

33
Machine learning (ML) monitoring is a crucial process for ensuring the performance and reliability of ML models and systems. It involves tracking metrics, identifying issues, and improving overall performance. In this article, we will explore the key aspects of ML monitoring and its importance in today's data-driven world.
44

5-
## What is Machine Learning Monitoring?
5+
## What is machine learning monitoring?
66

77
ML monitoring is the process of tracking the performance and behavior of ML models and systems. This includes monitoring metrics such as accuracy, precision, recall, and model performance over time. By monitoring these metrics, organizations can identify when a model is performing poorly or behaving unexpectedly and take action to correct it. Additionally, ML monitoring can be used to track the performance of different models and compare them to identify which model is performing best.
88

9-
## Detecting Poor Performance
9+
## Detecting poor performance
1010

1111
One of the key aspects of ML monitoring is being able to detect when a model is performing poorly or behaving unexpectedly. This can be done by setting up alerts on certain metrics or by monitoring for unexpected changes in the model's behavior. For example, if a model's accuracy suddenly drops, an alert can be triggered to notify the team responsible for maintaining the model. This allows them to quickly investigate and address the issue, minimizing the impact on the organization's operations.
1212

1313
## Monitoring data and concept drift
1414

1515
Another important aspect of ML monitoring is the ability to detect and address data and concept drifting. Data drifting refers to the gradual change in the distribution or characteristics of the input data over time. As the data changes, the model's performance may decrease, which is why it is important to detect data drifting and retrain the model with new data. Concept drifting, on the other hand, happens when the statistical properties of the target variable, which the model is trying to predict, change over time. This can happen due to various reasons such as changes in the underlying data distribution, overfitting, or degradation of the model's parameters. To address these issues, beside drift detection, organizations can use techniques such as monitoring of the performance of the model over time, retraining the model regularly etc.
1616

17-
## Monitoring Input Data
17+
## Monitoring input data
1818

1919
Another important aspect of ML monitoring is being able to track the input data that is being fed into the model. This can be used to identify any issues with the data, such as missing values or outliers, and to ensure that the data is being processed correctly. This helps to ensure that the model is making accurate predictions and that the data is being used effectively.
2020

21-
## Monitoring Infrastructure and Resources
21+
## Monitoring infrastructure and resources
2222

2323
Finally, it is important to monitor the infrastructure and resources that the ML models are running on. This includes monitoring things like CPU and memory usage, disk space, and network traffic. This helps to ensure that the models have the resources they need to perform well and to identify any potential bottlenecks that may be impacting performance. By monitoring the infrastructure, organizations can ensure that their models are running smoothly and can make adjustments as needed.
2424

docs/mkdocs/docs/sdk-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**_create_model_**_(name, type, features, prediction, probability, labels, description="")_
66

7-
Creates a model in the database. This model works placeholder for all the he actual model's metadata.
7+
Creates a model in the database. This model works as placeholder for all the actual model's metadata.
88

99
| Parameter | Type | Description |
1010
| --------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------- |

docs/mkdocs/docs/tutorial/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ $ helm install whitebox squaredev/whitebox
1616

1717
!!! info
1818

19-
Don't forget to get the API key and it somewhere safe!
19+
Don't forget to get the API key and store it somewhere safe!
2020

2121
If you lose it, you will need to delete the admin user in your database and re-run the live serve to produce a new key!
2222

docs/mkdocs/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ nav:
3737
- ml-monitoring.md
3838
- metric-definitions.md
3939

40-
- SDK Documantation: sdk-docs.md
40+
- sdk-docs.md
4141

4242
markdown_extensions:
4343
- pymdownx.arithmatex

helm_charts/whitebox/Chart.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
apiVersion: v2
22
name: whitebox
3-
description: A Machine Learning monitoring platform
3+
description: A Machine learning monitoring platform
44

55
type: application
66
version: 0.1.0
7-
appVersion: '0.1.0'
7+
appVersion: "0.1.0"
88

99
dependencies:
1010
- name: postgresql

0 commit comments

Comments
 (0)