NIAARM(1)

✨ NIAARM(1) ✨

okay so bestie, welcome to niaarm — she lives in your User Commands section and she's here to do exactly three things and she does them flawlessly 💅

🌸 NAME 🌸

niaarm – perform Association Rule Mining, output mined rules as csv, get mined rules' statistics

like. she mines the rules. she writes them to csv. she tells you the stats. main character behaviour fr fr 👑

🎀 SYNOPSIS 🎀

niaarm [-h] [-v] -i INPUT_FILE [-o OUTPUT_FILE] -a ALGORITHM [-s SEED]
[--max-evals MAX_EVALS] [--max-iters MAX_ITERS]
--metrics METRICS [METRICS ...]  [--weights WEIGHTS [WEIGHTS ...]]
[--log] [--stats]

no cap, that's the whole vibe check right there 🦋

💖 OPTIONS 💖

• -h, --help — show a help message and exit. your little safety net, she's got you 🫶
• -v, --verbose — show program's version number and exit. just the version, then she dips ✨
• -i INPUT_FILE, --input-file INPUT_FILE — input file containing a csv dataset. this is literally the dataset, you cannot skip this one 🍓
• -o OUTPUT_FILE, --output-file OUTPUT_FILE — output file for mined rules. where the mined rules go to live 🌈
• -a ALGORITHM, --algorithm ALGORITHM — algorithm to use (niapy class name, e.g. DifferentialEvolution). yes it wants the actual class name, give her the niapy class name 🙈
• -s SEED, --seed SEED — seed for the algorithm's random number generator. for when you want the randomness to be reproducible, iconic behaviour honestly ⭐
• --max-evals MAX_EVALS — maximum number of fitness function evaluations. the cap on how many times the fitness function gets evaluated, periodt 💀
• --max-iters MAX_ITERS — maximum number of iterations. the cap on iterations, that's the whole thing 🔥
• --metrics METRICS [METRICS ...] — metrics to use in the fitness function. note that trailing [METRICS ...] — she takes more than one, bestie 👑
• --weights WEIGHTS [WEIGHTS ...] — weights in range [0, 1] corresponding to --metrics. so keep them in that range and keep them lined up with your metrics, iykyk 💅
• --log — enable logging of fitness improvements. little diary entries every time fitness gets better 🎀
• --stats — display stats about mined rules. the receipts. the numbers. the whole tea 🧚

lowkey important: -i INPUT_FILE, -a ALGORITHM and --metrics are the ones with no brackets around them in the synopsis, so they're the mandatory girlies. everything else is optional 💜

and that's the page!! October 2022, NIAARM(1), User Commands — mwah, she ate and left no crumbs 🍓✨💖