Skip to content

Commit b339ebb

Browse files
authored
Update README.md
1 parent ef9ea2c commit b339ebb

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -231,30 +231,33 @@ in the GitHub repository.
231231

232232
We provide a simple command line interface, which allows you to easily
233233
mine association rules on any input dataset, output them to a csv file and/or perform
234-
a simple statistical analysis on them.
234+
a simple statistical analysis on them. For more details see the [documentation](https://niaarm.readthedocs.io/en/latest/cli.html).
235235

236236
```shell
237237
niaarm -h
238238
```
239239

240240
```
241-
usage: niaarm [-h] [-v] -i INPUT_FILE [-o OUTPUT_FILE] -a ALGORITHM [-s SEED]
242-
[--max-evals MAX_EVALS] [--max-iters MAX_ITERS] --metrics
243-
METRICS [METRICS ...] [--weights WEIGHTS [WEIGHTS ...]] [--log]
244-
[--show-stats]
241+
usage: niaarm [-h] [-v] [-c CONFIG] [-i INPUT_FILE] [-o OUTPUT_FILE] [--squashing-similarity {euclidean,cosine}] [--squashing-threshold SQUASHING_THRESHOLD] [-a ALGORITHM] [-s SEED] [--max-evals MAX_EVALS] [--max-iters MAX_ITERS]
242+
[--metrics METRICS [METRICS ...]] [--weights WEIGHTS [WEIGHTS ...]] [--log] [--stats]
245243
246244
Perform ARM, output mined rules as csv, get mined rules' statistics
247245
248246
options:
249247
-h, --help show this help message and exit
250248
-v, --version show program's version number and exit
249+
-c CONFIG, --config CONFIG
250+
Path to a TOML config file
251251
-i INPUT_FILE, --input-file INPUT_FILE
252252
Input file containing a csv dataset
253253
-o OUTPUT_FILE, --output-file OUTPUT_FILE
254254
Output file for mined rules
255+
--squashing-similarity {euclidean,cosine}
256+
Similarity measure to use for squashing
257+
--squashing-threshold SQUASHING_THRESHOLD
258+
Threshold to use for squashing
255259
-a ALGORITHM, --algorithm ALGORITHM
256-
Algorithm to use (niapy class name, e.g.
257-
DifferentialEvolution)
260+
Algorithm to use (niapy class name, e.g. DifferentialEvolution)
258261
-s SEED, --seed SEED Seed for the algorithm's random number generator
259262
--max-evals MAX_EVALS
260263
Maximum number of fitness function evaluations
@@ -265,7 +268,7 @@ options:
265268
--weights WEIGHTS [WEIGHTS ...]
266269
Weights in range [0, 1] corresponding to --metrics
267270
--log Enable logging of fitness improvements
268-
--show-stats Display stats about mined rules
271+
--stats Display stats about mined rules
269272
```
270273
Note: The CLI script can also run as a python module (`python -m niaarm ...`)
271274

0 commit comments

Comments
 (0)