Skip to content

Commit daef7b0

Browse files
Update README.md
1 parent 830deee commit daef7b0

File tree

1 file changed

+23
-40
lines changed

1 file changed

+23
-40
lines changed

README.md

Lines changed: 23 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -22,55 +22,44 @@
2222
<a href="https://www.evidentlyai.com/register">Evidently Cloud</a>
2323
</p>
2424

25-
# :new: New release
26-
27-
**Evidently 0.4.25**. LLM evaluation -> [Tutorial](https://docs.evidentlyai.com/tutorials-and-examples/tutorial-llm)
28-
2925
# :bar_chart: What is Evidently?
3026

3127
Evidently is an open-source Python library for ML and LLM evaluation and observability. It helps evaluate, test, and monitor AI-powered systems and data pipelines from experimentation to production. 
3228

33-
* 🔡 Works with tabular, text data, and embeddings.
29+
* 🔡 Works with tabular and text data.
3430
* ✨ Supports predictive and generative systems, from classification to RAG.
3531
* 📚 100+ built-in metrics from data drift detection to LLM judges.
36-
* 🛠️ Python interface for custom metrics and tests
32+
* 🛠️ Python interface for custom metrics. 
3733
* 🚦 Both offline evals and live monitoring.
3834
* 💻 Open architecture: easily export data and integrate with existing tools. 
3935

40-
Evidently is very modular. You can start with one-off evaluations using `Reports` or `Test Suites` in Python or get a real-time monitoring `Dashboard` service.
36+
Evidently is very modular. You can start with one-off evaluations using `Reports` in Python or host a monitoring `Dashboard` service.
4137

42-
## 1. Reports
38+
## 1. Reports and Test Suites
4339

44-
**Reports** compute various data, ML and LLM quality metrics. You can start with Presets or customize.
40+
**Reports** compute and summarize various data, ML and LLM quality metrics. You can start with Presets or customize.
4541
* Out-of-the-box interactive visuals.
46-
* Best for exploratory analysis and debugging.
47-
* Get results in Python, export as JSON, Python dictionary, HTML, DataFrame, or view in monitoring UI.
48-
49-
| Reports |
50-
|--|
51-
|![Report example](docs/book/.gitbook/assets/main/reports-min.png)|
52-
53-
## 2. Test Suites
42+
* Best for experiments, exploratory analysis and debugging.
43+
* Get results in Python, export as JSON, Python dictionary, HTML, or view in monitoring UI.
5444

55-
**Test Suites** check for defined conditions on metric values and return a pass or fail result.
56-
* Best for regression testing, CI/CD checks, or data validation pipelines.
45+
You can convert your Report into a **Test Suite** by adding pass/fail conditions on Metric values.
46+
* Best for regression testing, CI/CD checks, or data validation.
5747
* Zero setup option: auto-generate test conditions from the reference dataset.
58-
* Simple syntax to set custom test conditions as `gt` (greater than), `lt` (less than), etc.
59-
* Get results in Python, export as JSON, Python dictionary, HTML, DataFrame, or view in monitoring UI.
48+
* Simple syntax to set test conditions as `gt` (greater than), `lt` (less than), etc.
6049

61-
| Test Suite |
50+
| Reports |
6251
|--|
63-
|![Test example](docs/book/.gitbook/assets/main/tests.gif)|
52+
|![Report example](https://github.com/evidentlyai/docs/blob/eb1630cdd80d31d55921ff4d34fc7b5e6e9c9f90/images/concepts/report_test_preview.gif))|
6453

65-
## 3. Monitoring Dashboard
54+
## 2. Monitoring Dashboard
6655

6756
**Monitoring UI** service helps visualize metrics and test results over time.
6857

6958
You can choose:
7059
* Self-host the open-source version. [Live demo](https://demo.evidentlyai.com).
7160
* Sign up for [Evidently Cloud](https://www.evidentlyai.com/register) (Recommended).
7261

73-
Evidently Cloud offers a generous free tier and extra features like user management, alerting, and no-code evals.
62+
Evidently Cloud offers a generous free tier and extra features like dataset and user management, alerting, and no-code evals.
7463

7564
| Dashboard |
7665
|--|
@@ -91,8 +80,11 @@ conda install -c conda-forge evidently
9180

9281
# :arrow_forward: Getting started
9382

94-
### Option 1: Test Suites
95-
> This is a simple Hello World. Check the Tutorials for more: [Tabular data](https://docs.evidentlyai.com/tutorials-and-examples/tutorial_reports_tests) or [LLM evaluation](https://docs.evidentlyai.com/tutorials-and-examples/tutorial-llm).
83+
## Reports
84+
85+
### LLM evals
86+
87+
> This is a simple Hello World. Check the Tutorials for more: [Tabular data](https://docs.evidentlyai.com/quickstart_ml) or [LLM evaluation](https://docs.evidentlyai.com/quickstart_llm).
9688
9789
Import the **Test Suite**, evaluation Preset and toy tabular dataset.
9890

@@ -130,7 +122,7 @@ data_stability.json()
130122
```
131123
You can choose other Presets, individual Tests and set conditions.
132124

133-
### Option 2: Reports
125+
### Data and ML evals
134126

135127
Import the **Report**, evaluation Preset and toy tabular dataset.
136128

@@ -168,7 +160,7 @@ data_drift_report.json()
168160

169161
You can choose other Presets and individual Metrics, including LLM evaluations for text data.
170162

171-
### Option 3: ML monitoring dashboard
163+
## Monitoring dashboard
172164
> This launches a demo project in the Evidently UI. Check tutorials for [Self-hosting](https://docs.evidentlyai.com/tutorials-and-examples/tutorial-monitoring) or [Evidently Cloud](https://docs.evidentlyai.com/tutorials-and-examples/tutorial-cloud).
173165
174166
Recommended step: create a virtual environment and activate it.
@@ -187,7 +179,7 @@ Access Evidently UI service in your browser. Go to the **localhost:8000**.
187179

188180
# 🚦 What can you evaluate?
189181

190-
Evidently has 100+ built-in evals. You can also add custom ones. Each metric has an optional visualization: you can use it in `Reports`, `Test Suites`, or plot on a `Dashboard`.
182+
Evidently has 100+ built-in evals. You can also add custom ones.
191183

192184
Here are examples of things you can check:
193185

@@ -207,16 +199,7 @@ Here are examples of things you can check:
207199
We welcome contributions! Read the [Guide](CONTRIBUTING.md) to learn more.
208200

209201
# :books: Documentation
210-
For more information, refer to a complete <a href="https://docs.evidentlyai.com">Documentation</a>. You can start with the tutorials:
211-
* [Get Started with Tabular and ML Evaluation](https://docs.evidentlyai.com/tutorials-and-examples/tutorial_reports_tests)
212-
* [Get Started with LLM Evaluation](https://docs.evidentlyai.com/tutorials-and-examples/tutorial-llm)
213-
* [Self-hosting ML monitoring Dashboard](https://docs.evidentlyai.com/tutorials-and-examples/tutorial-monitoring)
214-
* [Cloud ML monitoring Dashboard](https://docs.evidentlyai.com/tutorials-and-examples/tutorial-cloud)
215-
216-
See more examples in the [Docs]([https://docs.evidentlyai.com/tutorials-and-examples](https://docs.evidentlyai.com/tutorials-and-examples/examples)).
217-
218-
## How-to guides
219-
Explore the [How-to guides](https://github.com/evidentlyai/evidently/tree/main/examples/how_to_questions) to understand specific features in Evidently.
202+
For more examples, refer to a complete <a href="https://docs.evidentlyai.com">Documentation</a>.
220203

221204
# :white_check_mark: Discord Community
222205
If you want to chat and connect, join our [Discord community](https://discord.gg/xZjKRaNp8b)!

0 commit comments

Comments
 (0)