From c5080e48642cf8def754fa4946fa42e2ab7a7163 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABl=20Madon?= <mael.madon@irit.fr> Date: Thu, 1 Dec 2022 11:22:46 +0100 Subject: [PATCH] readme: describe the notebook files --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index f087a6c..7920c2a 100644 --- a/README.md +++ b/README.md @@ -28,5 +28,14 @@ python3 swf2userSessions.py -a 60 workloads/example.swf out/ For more documentation, see: `python3 swf2userSessions.py -h` + +## Example + +For example use of the script, you can have a look at these two notebooks: + +- `session_stats.ipynb` makes the session decomposition on three traces with diffent threshold values and compare statistical properties like number of session or session length +- `graph_viz.ipynb` showcases the simple graph visualization tool for session graphs that is included in the script (option `--graph`) + + ## Tests Some integration tests have been written for this script, and are stored in the `test/` folder. To run them on your machine, just type `pytest` at the root of the project. \ No newline at end of file -- GitLab