Skip to content

Commit 2a0f75b

Browse files
committed
add brief description of contest estimator
1 parent 4b9ca2d commit 2a0f75b

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
@@ -134,9 +134,17 @@ TODO (Nikita Stroganov)
134134
TODO (Nikita Stroganov)
135135

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

138-
TODO (Rustam Sadykov)
139+
It is placed in [utbot-junit-contest][contest estimator 1] module and has several entry points:
140+
- [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.
141+
- [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.
142+
It is used to [monitor and chart][contest estimator 4] statistics every night.
139143

144+
[contest estimator 1]: ../utbot-junit-contest
145+
[contest estimator 2]: ../utbot-junit-contest/src/main/kotlin/org/utbot/contest/ContestEstimator.kt
146+
[contest estimator 3]: ../utbot-junit-contest/src/main/kotlin/org/utbot/monitoring/StatisticsMonitoring.kt
147+
[contest estimator 4]: NightStatisticsMonitoring.md
140148

141149
# Components
142150

0 commit comments

Comments
 (0)