From 408c93c863aa531da1d988e0b6c17151a4bf5511 Mon Sep 17 00:00:00 2001
From: George Chernishev <chernishev@gmail.com>
Date: Thu, 5 Dec 2024 20:30:25 +0300
Subject: [PATCH] Update files for release of 1.1.1

Update README by adding mentions of all merged patterns (needed for release). Update toml file and fix afd example with new metrics.
---
 README.md      | 19 +++++++++++++------
 pyproject.toml |  4 ++--
 2 files changed, 15 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index c942abf..4e8b91e 100644
--- a/README.md
+++ b/README.md
@@ -31,10 +31,16 @@ The **Discovery** task is designed to identify all instances of a specified patt
 The **Validation** task is different: it is designed to check whether a specified pattern *instance* is present in a given dataset. This task not only returns True or False, but it also explains why the instance does not hold (e.g. it can list table rows with conflicting values).
 
 The currently supported data patterns are:
-* Functional dependency variants:
-    - Exact functional dependencies (discovery and validation)
-    - Approximate functional dependencies, with g<sub>1</sub> metric (discovery and validation)
-    - Probabilistic functional dependencies, with PerTuple and PerValue metrics (discovery)
+* Exact functional dependencies (discovery and validation)
+* Approximate functional dependencies, with 
+    - $g_1$ metric — classic AFDs (discovery and validation)
+    - $\mu+$ metric (discovery)
+    - $\tau$ metric (discovery)
+    - $pdep$ metric (discovery)
+    - $\rho$ metric (discovery)
+* Probabilistic functional dependencies, with PerTuple and PerValue metrics (discovery and validation)
+* Classic soft functional dependencies (with corellations), with $\rho$ metric (discovery and validation)
+* Numerical dependencies (validation)
 * Graph functional dependencies (validation)
 * Conditional functional dependencies (discovery)
 * Inclusion dependencies (discovery)
@@ -43,9 +49,10 @@ The currently supported data patterns are:
    - list-based axiomatization (discovery)
 * Metric functional dependencies (validation)
 * Fuzzy algebraic constraints (discovery)
+* Differential Dependencies (discovery)
 * Unique column combinations:
-   - Exact unique column combination (discovery and validation)
    - Approximate unique column combination, with g<sub>1</sub> metric (discovery and validation)
+   - Approximate unique column combination, with $g_1$ metric (discovery and validation)
 * Association rules (discovery)
 
 For more information about the supported patterns check the main [repo](https://github.com/Desbordante/desbordante-core).
@@ -89,7 +96,7 @@ desbordante --task=fd --table=../examples/datasets/university_fd.csv , True
 2) Discover all approximate functional dependencies with error less than or equal to 0.1 in a table represented by a .csv file that uses a comma as the separator and has a header row. In this example the default AFD discovery algorithm (Pyro) is used.
 
 ```sh
-desbordante --task=afd --table=../examples/datasets/inventory_afd.csv , True --error=0.1
+desbordante --task=afd --algo=tane --table=../examples/datasets/inventory_afd.csv , True --afd_error_measure=g1 --error=0.1
 ```
 
 ```text
diff --git a/pyproject.toml b/pyproject.toml
index 5cd36d2..83228b9 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "desbordante-cli"
-version = "1.1.0"
+version = "1.1.1"
 description = "CLI interface for Desbordante platform"
 authors = ["Desbordante Team <chernishev@gmail.com>"]
 license = "AGPL-3.0-or-later"
@@ -11,7 +11,7 @@ packages = [
 
 [tool.poetry.dependencies]
 python = ">=3.11"
-desbordante = "2.1.0"
+desbordante = "2.2.0"
 click = "^8.1.7"