docs: Add model-improvement.md (#24813)

This commit is contained in:
Peter Tripp 2025-02-13 20:37:49 +00:00 committed by GitHub
parent 8c202b3b09
commit 8b85d26981
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 82 additions and 0 deletions

View file

@ -45,6 +45,7 @@
- [Prompts](./assistant/prompting.md)
- [Context Servers](./assistant/context-servers.md)
- [Model Context Protocol](./assistant/model-context-protocol.md)
- [Model Improvement](./model-improvement.md)
# Extensions

View file

@ -0,0 +1,81 @@
# Zed Model Improvement
## Zed Assistant
When using the Zed Assistant, Zed does not persistently store user content or use user content for training of its models.
When using upstream services through Zed AI, we require similar assurances from our service providers. For example, usage of Anthropic Claude 3.5 via Zed AI in the Asssistant is governed by the [Anthropic Commercial Terms](https://www.anthropic.com/legal/commercial-terms) which includes the following:
> "Anthropic may not train models on Customer Content from paid Services."
When you directly connect the Zed Assistant with a non Zed AI service (e.g. via API key) Zed does not have access to your user content. Users should reference their agreement with the service provider to understand what terms and conditions apply.
## Zed Edit Predictions
By default, when using Zed Edit Predictions, Zed does not persistently store user content or use user content for training of its models.
### Opt-in
Users who are working on open source licensed projects may optionally opt-in to providing model improvement feedback. This opt-in occurs on a per-project basis. If you work on multiple open source projects and wish to provide model improvement feedback you will have to opt-in for each individual project.
When working on other projects where you haven't opted-in, Zed will not persistently store user content or use user content for training of its models.
You can see exactly how Zed detects open source licenses in: [license_detection.rs](https://github.com/zed-industries/zed/blob/main/crates/zeta/src/license_detection.rs).
### Exclusions
Zed will intentionally exclude certain files from Predictive Edits entirely, even when you have opted-in to model improvement feedback.
You can inspect this exclusion list by opening `zed: open default settings` from the command palette:
```json
{
"edit_predictions": {
// A list of globs representing files that edit predictions should be disabled for.
// There's a sensible default list of globs already included.
// Any addition to this list will be merged with the default list.
"disabled_globs": [
"**/.env*",
"**/*.pem",
"**/*.key",
"**/*.cert",
"**/*.crt",
"**/secrets.yml"
]
}
}
```
Users may explicitly exclude additional paths and/or file extensions by adding them to [`edit_predictions.disabled_globs`](https://zed.dev/docs/configuring-zed#edit-predictions) in their Zed settings.json:
```json
{
"edit_predictions": {
"disabled_globs": ["secret_dir/*", "**/*.log"]
}
}
```
### Data we collect
For open source projects where you have opted-in, Zed may store copies of requests and responses to the Zed AI Prediction service.
This data includes:
- the edit prediction
- a portion of the buffer content around the cursor
- a few recent edits
- the current buffer outline
- diagnostics (errors, warnings, etc) from language servers
### Data Handling
Collected data is stored in Snowflake, a private database where we track other metrics. We periodically review this data to select training samples for inclusion in our model training dataset. We ensure any included data is anonymized and contains no sensitive information (access tokens, user IDs, email addresses, etc). This training dataset is publicly available at: [huggingface.co/datasets/zed-industries/zeta](https://huggingface.co/datasets/zed-industries/zeta).
### Model Output
We then use this training dataset to fine-tune [Qwen2.5-Coder-7B](https://huggingface.co/Qwen/Qwen2.5-Coder-7B) and make the resulting model available here at [github.com/zed-industries/zeta](https://github.com/zed-industries/zeta) and [huggingface.co/zed-industries/zeta](https://huggingface.co/zed-industries/zeta).
## Applicable terms
Please see the [Zed Terms of Service](https://zed.dev/terms-of-service) for more.