Skip to content

Commit fc43cb6

Browse files
committed
Added comment.
1 parent 7f4b616 commit fc43cb6

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/utils/stats_processor.py

+17
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,23 @@
88

99

1010
class StatsProcessor:
11+
"""
12+
The class is used for storing of additional statistics, that need be stored on the local system.
13+
For example, number of usages of OpenVino.
14+
The class is used by main Telemetry class, for example:
15+
16+
stats_processor = StatsProcessor()
17+
created = stats_processor.create_new_stats_file()
18+
19+
# store statistics
20+
updated = stats_processor.update_stats({"usage_count": 1})
21+
22+
# read statistics
23+
read_status, stats = stats_processor.get_stats()
24+
25+
# remove statistics file
26+
stats_processor.remove_stats_file()
27+
"""
1128
def __init__(self):
1229
self.opt_in_checker = OptInChecker()
1330

0 commit comments

Comments
 (0)