Skip to content

Commit 5fd6875

Browse files
toadharvardchernishev
authored andcommitted
Update installation paragraph
1 parent fba8db0 commit 5fd6875

File tree

1 file changed

+24
-17
lines changed

1 file changed

+24
-17
lines changed

README_CONSOLE.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
## Table of Contents
1414

1515
- [Main Features](#main-features)
16-
- [Usage Examples](#usage-examples)
1716
- [Installation](#installation)
17+
- [Usage Examples](#usage-examples)
1818
- [Contacts and Q&A](#contacts-and-qa)
1919

2020
# Main Features
@@ -45,13 +45,30 @@ The currently supported data patterns are:
4545

4646
For more information about the supported patterns check the main [repo](https://github.com/Desbordante/desbordante-core).
4747

48+
## Installation
49+
50+
**Requrements**:
51+
* Python 3.11+
52+
* pipx
53+
* [`desbordante` package](https://pypi.org/project/desbordante/) requirements
54+
55+
### PyPI
56+
Run the following command:
57+
```sh
58+
pipx install desbordante-cli
59+
```
60+
### Git
61+
```sh
62+
pipx install git+https://github.com/desbordante/desbordante-cli
63+
```
64+
4865
## Usage examples
66+
Example datasets can be found at main [repo](https://github.com/Desbordante/desbordante-core)
4967

50-
Usage examples:
5168
1) Discover all exact functional dependencies in a table stored in a comma-separated file with a header row. In this example the default FD discovery algorithm (HyFD) is used.
5269

5370
```sh
54-
python3 cli.py --task=fd --table=../examples/datasets/university_fd.csv , True
71+
desbordante --task=fd --table=../examples/datasets/university_fd.csv , True
5572
```
5673

5774
```text
@@ -67,7 +84,7 @@ python3 cli.py --task=fd --table=../examples/datasets/university_fd.csv , True
6784
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.
6885

6986
```sh
70-
python3 cli.py --task=afd --table=../examples/datasets/inventory_afd.csv , True --error=0.1
87+
desbordante --task=afd --table=../examples/datasets/inventory_afd.csv , True --error=0.1
7188
```
7289

7390
```text
@@ -79,28 +96,18 @@ python3 cli.py --task=afd --table=../examples/datasets/inventory_afd.csv , True
7996
3) Check whether metric functional dependency “Title -> Duration” with radius 5 (using the Euclidean metric) holds 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 MFD validation algorithm (BRUTE) is used.
8097

8198
```sh
82-
python3 cli.py --task=mfd_verification --table=../examples/datasets/theatres_mfd.csv , True --lhs_indices=0 --rhs_indices=2 --metric=euclidean --parameter=5
99+
desbordante --task=mfd_verification --table=../examples/datasets/theatres_mfd.csv , True --lhs_indices=0 --rhs_indices=2 --metric=euclidean --parameter=5
83100
```
84101

85102
```text
86103
True
87104
```
88105

89106
For more information check the --help option:
90-
91107
```sh
92108
desbordante --help
93109
```
94110

95-
## Installation
96-
97-
The source code is currently hosted on GitHub at https://github.com/Desbordante/desbordante-console. In order for this to run, first you have to have install the latest version of the main Desbordante [package](https://pypi.org/project/desbordante/).
111+
# Contacts and Q&A
98112

99-
**NOTE**: Only Python 3.11+ is supported for CLI
100-
101-
Run the following commands:
102-
103-
```sh
104-
pip install -r cli/requirements.txt
105-
python3 cli/cli.py --help
106-
```
113+
If you have any questions regarding the tool you can create an [issue](https://github.com/Desbordante/desbordante-cli/issues) at GitHub.

0 commit comments

Comments
 (0)