From 5b5f293c0bb33c1fbe4409a8ce3916fa522472d6 Mon Sep 17 00:00:00 2001 From: Faith Xu Date: Fri, 18 Oct 2019 12:32:36 -0700 Subject: [PATCH 1/5] Rearrange content order --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7a519b9682577..27282b44d92ea 100644 --- a/README.md +++ b/README.md @@ -30,11 +30,12 @@ * [Technical Design Details](#technical-design-details) * [Extensibility Options](#extensibility-options) +**[Data/Telemetry](#Data/Telemetry)** + **[Contributions and Feedback](#contribute)** **[License](#license)** -**[Data/Telemetry](#Data/Telemetry)** *** # Key Features ## Run any ONNX model @@ -162,6 +163,10 @@ To tune performance for ONNX models, the [ONNX Go Live tool "OLive"](https://git transform](include/onnxruntime/core/optimizer/graph_transformer.h) * [Add a new rewrite rule](include/onnxruntime/core/optimizer/rewrite_rule.h) +*** +# Data/Telemetry +This project may collect usage data and send it to Microsoft to help improve our products and services. See the [privacy statement](docs/Privacy.md) for more details. + *** # Contribute We welcome contributions! Please see the [contribution guidelines](CONTRIBUTING.md). @@ -173,9 +178,6 @@ For any feedback or to report a bug, please file a [GitHub Issue](https://github This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. -*** -# Data/Telemetry -This project collects usage data and sends it to Microsoft to help improve our products and services. See the [privacy statement](docs/Privacy.md) for more details. *** # License From ee23dd7b003897814335ca49e63b8a11a739596c Mon Sep 17 00:00:00 2001 From: Faith Xu Date: Fri, 18 Oct 2019 12:36:14 -0700 Subject: [PATCH 2/5] Reorganize page --- docs/Privacy.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/Privacy.md b/docs/Privacy.md index 822e1da6f8bee..eba4d33a1a00a 100644 --- a/docs/Privacy.md +++ b/docs/Privacy.md @@ -1,10 +1,17 @@ -# Data Collection +# Privacy + +## Data Collection The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices. +*** + +### Private Builds Note that no data collection is performed by default when using your private builds. -Telemetry is turned OFF by default while this feature is in BETA. When the feature moves from BETA to RELEASE, developers should expect telemetry to be ON by default when using the Official Builds. This is implemented via 'Platform Telemetry' per vendor platform providers (see telemetry.h). +### Official Builds +Currently telemetry is only implemented for Windows builds, but may be expanded in the future to cover other platforms. Telemetry is turned OFF by default while this feature is in BETA. When the feature moves from BETA to RELEASE, developers should expect telemetry to be ON by default when using the Official Builds. This is implemented via 'Platform Telemetry' per vendor platform providers (see telemetry.h). +#### Technical Details The Windows provider uses the [TraceLogging](https://docs.microsoft.com/en-us/windows/win32/tracelogging/trace-logging-about) API for its implementation. You can turn this on or off using the Enable/DisableTelemetryEvents() C API. From ed7ea73e32c42d7d7f57262139db16ecb51ccb3b Mon Sep 17 00:00:00 2001 From: Faith Xu Date: Fri, 18 Oct 2019 12:39:52 -0700 Subject: [PATCH 3/5] Update telemetry text --- docs/C_API.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/C_API.md b/docs/C_API.md index 92e0f2456ce1a..d9ba528923b19 100644 --- a/docs/C_API.md +++ b/docs/C_API.md @@ -31,9 +31,4 @@ The example below shows a sample run using the SqueezeNet model from ONNX model * [../csharp/test/Microsoft.ML.OnnxRuntime.EndToEndTests.Capi/C_Api_Sample.cpp](../csharp/test/Microsoft.ML.OnnxRuntime.EndToEndTests.Capi/C_Api_Sample.cpp) # Telemetry -This project collects usage data and sends it to Microsoft to help improve our products and services. Note however that no data collection is performed by default when using your private builds - -Telemetry is turned OFF by default while this feature is in BETA. When the feature moves from BETA to RELEASE, developers should expect telemetry to be ON by default when using the Official Builds. This is implemented via 'Platform Telemetry' per vendor platform providers (see telemetry.h). - -The Windows provider uses the [TraceLogging](https://docs.microsoft.com/en-us/windows/win32/tracelogging/trace-logging-about) API for its implementation. - +To turn on/off telemetry collection on official Windows builds, please use Enable/DisableTelemetryEvents() in the C API. See the [Privacy](./Privacy.md) page for more information on telemetry collection and Microsoft's privacy policy. From 40bad60744dee3f8eb4d47c819b0a3242c42cc2e Mon Sep 17 00:00:00 2001 From: Faith Xu Date: Fri, 18 Oct 2019 12:40:11 -0700 Subject: [PATCH 4/5] Update C_API.md --- docs/C_API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/C_API.md b/docs/C_API.md index d9ba528923b19..30a626fa102e1 100644 --- a/docs/C_API.md +++ b/docs/C_API.md @@ -30,5 +30,5 @@ The example below shows a sample run using the SqueezeNet model from ONNX model * [../csharp/test/Microsoft.ML.OnnxRuntime.EndToEndTests.Capi/C_Api_Sample.cpp](../csharp/test/Microsoft.ML.OnnxRuntime.EndToEndTests.Capi/C_Api_Sample.cpp) -# Telemetry +## Telemetry To turn on/off telemetry collection on official Windows builds, please use Enable/DisableTelemetryEvents() in the C API. See the [Privacy](./Privacy.md) page for more information on telemetry collection and Microsoft's privacy policy. From eedc07b845e1506dcc55e772e11de8393c2b7c8f Mon Sep 17 00:00:00 2001 From: Faith Xu Date: Fri, 18 Oct 2019 12:44:11 -0700 Subject: [PATCH 5/5] Update Privacy.md --- docs/Privacy.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/Privacy.md b/docs/Privacy.md index eba4d33a1a00a..9292d989ecfed 100644 --- a/docs/Privacy.md +++ b/docs/Privacy.md @@ -6,7 +6,7 @@ The software may collect information about you and your use of the software and *** ### Private Builds -Note that no data collection is performed by default when using your private builds. +No data collection is performed when using your private builds. ### Official Builds Currently telemetry is only implemented for Windows builds, but may be expanded in the future to cover other platforms. Telemetry is turned OFF by default while this feature is in BETA. When the feature moves from BETA to RELEASE, developers should expect telemetry to be ON by default when using the Official Builds. This is implemented via 'Platform Telemetry' per vendor platform providers (see telemetry.h). @@ -14,4 +14,5 @@ Currently telemetry is only implemented for Windows builds, but may be expanded #### Technical Details The Windows provider uses the [TraceLogging](https://docs.microsoft.com/en-us/windows/win32/tracelogging/trace-logging-about) API for its implementation. -You can turn this on or off using the Enable/DisableTelemetryEvents() C API. +For API usage details to turn this on/off, please check the API pages: +* [C API](./C_API.md#telemetry)