Skip to content

Commit

Permalink
fix (#1374)
Browse files Browse the repository at this point in the history
  • Loading branch information
SkafteNicki authored Dec 4, 2024
1 parent 0d9c075 commit c7e90e2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 26 deletions.
8 changes: 4 additions & 4 deletions docs/book/presets/text-overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**TL;DR:** You can explore and compare text datasets.

* **Report**: for visual analysis or metrics export, use the `TextOverviewPreset`.
* **Report**: for visual analysis or metrics export, use the `TextEvals`.

# Use case

Expand All @@ -14,13 +14,13 @@ You can evaluate and explore text data:

# Text Overview Report

If you want to visually explore the text data, you can create a new Report object and use the `TextOverviewPreset`.
If you want to visually explore the text data, you can create a new Report object and use the `TextEvals`.

## Code example

```python
text_overview_report = Report(metrics=[
TextOverviewPreset(column_name="Review_Text")
TextEvals(column_name="Review_Text")
])

text_overview_report.run(reference_data=ref, current_data=cur)
Expand All @@ -38,7 +38,7 @@ nltk.download('omw-1.4')

## How it works

The `TextOverviewPreset` provides an overview and comparison of text datasets.
The `TextEvals` provides an overview and comparison of text datasets.
* Generates a **descriptive summary** of the text columns in the dataset.
* Performs **data drift detection** to compare the two texts using the domain classifier approach.
* Shows distributions of the **text descriptors** in two datasets, and their **correlations** with other features.
Expand Down
25 changes: 3 additions & 22 deletions docs/book/reference/all-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,28 +147,6 @@ How to set [data drift parameters](../customization/options-for-statistical-test

</details>

<details>

<summary>Text Overview Preset</summary>

`TextOverviewPreset()` provides a summary for a single or multiple text columns. Text columns are required.

**Composition**:
* `ColumnSummaryMetric()` for text descriptors for all columns. Descriptors included:
* `Sentiment()`
* `SentenceCount()`
* `OOV()`
* `TextLength()`
* `NonLetterCharacterPercentage()`
* `SemanticSimilarity()` between each pair of text columns, if there is more than one.

**Required parameters**:
* `column_name` or `columns` list

**Optional parameters**:
* `descriptors` list

</details>

<details>

Expand All @@ -187,6 +165,9 @@ How to set [data drift parameters](../customization/options-for-statistical-test
**Required parameters**:
* `column_name`

**Optional parameters**:
* `descriptors` list

</details>

<details>
Expand Down

0 comments on commit c7e90e2

Please sign in to comment.