Skip to content

Commit

Permalink
Update files for release of 1.1.1
Browse files Browse the repository at this point in the history
Update README by adding mentions of all merged patterns (needed for release). Update toml file and fix afd example with new metrics.
  • Loading branch information
chernishev authored and toadharvard committed Dec 5, 2024
1 parent 95a0484 commit 408c93c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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).
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>"]
license = "AGPL-3.0-or-later"
Expand All @@ -11,7 +11,7 @@ packages = [

[tool.poetry.dependencies]
python = ">=3.11"
desbordante = "2.1.0"
desbordante = "2.2.0"
click = "^8.1.7"


Expand Down

0 comments on commit 408c93c

Please sign in to comment.