Table of contents:
Some UML file have been created to help understand and begin to work on the project. These files were written using the PlantUML syntax. This syntax has the advantage of being in text format. This makes it easier to use on git (unlike the binary format).
Each UML Schema is store in two format: picture (in PNG) and source code (in TXT).
To correctly understand the project, it is important to understand the different link between classes.
The class dependencies (only helpers) - (Source code)
The previous schema is a simplification. In the following schema, all class are represented:
The class dependencies - (Source code)
Visit the whitelist page to understand what is the role of the whitelist. Concretely, whitelist is used when an outliers is detected. If the outlier is whitelisted, it is removed and the current batch is recompute.
Concretely, for metrics, the process is the following:
Process of Metrics (linked to whitelisted) - (Source code)
Another view is the "activity" diagram, which allow to understand the different looop and the differents steps in Metrics:
Activity diagram for Metrics - (Source code)