Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add telemetry disclaimer to readme (#449) #476

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,15 @@ Hold Alt key and click on tag name, user can change the tag's name.

To delete all labels for a tag - select all labels for a tag on document then press 'delete' key.

### **Disclaimer**
For development purposes and for better understanding of our tool usage we are collecting some data, such as:

custom events (training, model compose and prediction), Form recognizer API version, browser version, OS version, approximate location (according your ISP: country and city)

*If you do not like to share this information with us, feel free to delete telemetry key. It is located at ```src/common/constant.ts```. It should not affect any of the tool's operations.*

Alternatively if you want to gather your own telemetry - you can just replace the **insightsKey** with your own. We use **Azure Application Insights** telemetry service. All related docs are [here](https://docs.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview).

## Collaborators

This project is cloned and modified from [VoTT](https://github.com/microsoft/VoTT) project.
Expand Down