Skip to content

Commit

Permalink
Update README.md: rewrite of web interface section; language clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
chernishev authored Nov 30, 2023
1 parent 95657d2 commit d14ea79
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,9 @@ else:

## Web interface

While the Python interface makes building interactive applications possible, Desbordante also offers a web interface which is aimed specifically for interactive tasks. For pattern discovery/validation a user may specify parameters, browse results, employ advanced visualizations and filters, all in a convenient way. Furthermore, we select the most interesting Python scenarios and implement them in the web version. Currently, only the typo detection scenario is implemented.
While the Python interface makes building interactive applications possible, Desbordante also offers a web interface which is aimed specifically for interactive tasks. Such tasks typically involve multiple steps and require substantial user input on each of them. Interactive tasks usually originate from Python scenarios, i.e. we select the most interesting ones and implement them in the web version. Currently, only the typo detection scenario is implemented. The web interface is also useful for pattern discovery and validation tasks: a user may specify parameters, browse results, employ advanced visualizations and filters, all in a convenient way.

You can try the deployed web version [here](https://desbordante.unidata-platform.ru/). You have to register in order to process your own datasets. Keep in mind that due to a large demand various time and memory limits are enforced (and a task is killed if it goes outside the acceptable ranges). The source code of the web interface is kept in a separate [repo](https://github.com/vs9h/Desbordante).
You can try the deployed web version [here](https://desbordante.unidata-platform.ru/). You have to register in order to process your own datasets. Keep in mind that due to a large demand various time and memory limits are enforced: processing is aborted if they are exceeded. The source code of the web interface is kept in a separate [repo](https://github.com/vs9h/Desbordante).

## Build instructions

Expand Down Expand Up @@ -237,14 +237,11 @@ The `input_data` directory contains several .csv files that may be used by `Desb
cd build/target
./Desbordante_test
```
The tool itself is launched via the following line:
The tool itself may be run like the following:
```
./Desbordante_run --algo=tane --data=<dataset_name>.csv
./Desbordante_run --algo=tane --data=<path_to_dataset>
```

The `<dataset_name>.csv`, which is a user-provided dataset, should be placed in the `/path/to/Desbordante/build/target` directory.


## Cite
If you use this software for research, please cite one of our papers:
1) George Chernishev, et al. Solving Data Quality Problems with Desbordante: a Demo. CoRR abs/2307.14935 (2023).
Expand Down

0 comments on commit d14ea79

Please sign in to comment.