Skip to content

Commit 55764e2

Browse files
committed
add brief description of contest estimator
1 parent 0f11d33 commit 55764e2

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/OverallArchitecture.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,17 @@ TODO (Nikita Stroganov)
129129
TODO (Nikita Stroganov)
130130

131131
### Contest estimator
132+
The main responsibility of Contest estimator is running UTBot on prepared projects in advance and providing some statistics such as instruction coverage.
132133

133-
TODO (Rustam Sadykov)
134+
It is placed in [utbot-junit-contest][contest estimator 1] module and has several entry points:
135+
- [ContestEstimator.kt][contest estimator 2] - the main entry point of Contest estimator, it runs UTBot on specified projects, calculates some statistics for target classes and projects and outputs them in a console.
136+
- [StatisticsMonitoring.kt][contest estimator 3] - an additional entry point of Contest estimator which does the same as the previous one, but can be configured from a file and dumps output statistics to a file.
137+
It is used to [monitor and chart][contest estimator 4] statistics every night.
134138

139+
[contest estimator 1]: ../utbot-junit-contest
140+
[contest estimator 2]: ../utbot-junit-contest/src/main/kotlin/org/utbot/contest/ContestEstimator.kt
141+
[contest estimator 3]: ../utbot-junit-contest/src/main/kotlin/org/utbot/monitoring/StatisticsMonitoring.kt
142+
[contest estimator 4]: NightStatisticsMonitoring.md
135143

136144
# Components
137145

0 commit comments

Comments
 (0)