From a9ad74b69091fab2f226b3755dcf99d610ce8012 Mon Sep 17 00:00:00 2001 From: Karol Blaszczak Date: Wed, 7 Dec 2022 11:15:24 +0100 Subject: [PATCH] DOCS- add telemetry info page (#14463) --- docs/resources/resources.md | 1 + docs/resources/telemetry_information.md | 79 +++++++++++++++++++++++++ 2 files changed, 80 insertions(+) create mode 100644 docs/resources/telemetry_information.md diff --git a/docs/resources/resources.md b/docs/resources/resources.md index 7acc33c9ab9..1997f466a20 100644 --- a/docs/resources/resources.md +++ b/docs/resources/resources.md @@ -14,6 +14,7 @@ openvino_docs_MO_DG_prepare_model_Supported_Frameworks_Layers openvino_docs_OV_Glossary openvino_docs_Legal_Information + openvino_docs_telemetry_information .. toctree:: diff --git a/docs/resources/telemetry_information.md b/docs/resources/telemetry_information.md new file mode 100644 index 00000000000..57dba706ecb --- /dev/null +++ b/docs/resources/telemetry_information.md @@ -0,0 +1,79 @@ +# OpenVINO™ Telemetry {#openvino_docs_telemetry_information} + +@sphinxdirective + +To facilitate debugging and further development, OpenVINO™ asks its users for +a permission to collect telemetry data. It will not be collected +without an explicit consent on your part and will cover only OpenVINO™ usage information. +It does not extend to any other Intel software, hardware, website usage, or other products. + +Google Analytics is used for telemetry purposes. Refer to +:ref:`Google Analytics support` to understand how the data is collected and processed. + +Enable or disable Telemetry reporting +====================================== + +First-run consent +-------------------------------------- + +On the first run of an application that collects telemetry data, you will be prompted +to opt in or out of telemetry collection with the following telemetry message: + +.. code-block:: console + + Intel would like your permission to collect software performance and usage data + for the purpose of improving Intel products and services. This data will be collected + directly by Intel or through the use of Google Analytics. This data will be stored + in countries where Intel or Google operate. + + You can opt-out at any time in the future by running 'opt_in_out --opt_in'. + + More Information is available at docs.openvino.ai. + + Please type 'Y' to give your consent or 'N' to decline. + +Choose your preference by typing 'Y' to enable or 'N' to disable telemetry. Your choice will +be confirmed by a corresponding disclaimer. If you do not reply to the telemetry message, +your telemetry data will not be collected. + +For the Neural Network Compression Framework (NNCF), which is not a command line application, +the telemetry message will not display. Telemetry data will only be collected from NNCF +if you have explicitly provided consent in another OpenVINO tool. + + +Changing consent decision +-------------------------------------- + +You can change your data collection decision with the following command lines: + +`opt_in_out --opt_in` - enable telemetry + +`opt_in_out --opt_out` - disable telemetry + + +Telemetry Data Collection Details +====================================== + +.. tab:: Telemetry Data Collected + + * Failure reports + * Error reports + * Usage data + +.. tab:: Tools Collecting Data + + * Model Optimizer + * Model Downloader + * Accuracy Checker + * Post-Training Optimization Toolkit + * Neural Network Compression Framework + * Model Converter + * Model Quantizer + +.. tab:: Telemetry Data Retention + + Telemetry data is retained in Google Analytics for a maximum of 26 months. + Any raw data that has reached the 26-month threshold is deleted from Google Analytics on a monthly basis. + + +@endsphinxdirective \ No newline at end of file