Skip to content

docs: update TELEMETRY.md to reflect current event set#893

Merged
noahho merged 2 commits intomainfrom
docs/telemetry-md-current-event-set
Apr 23, 2026
Merged

docs: update TELEMETRY.md to reflect current event set#893
noahho merged 2 commits intomainfrom
docs/telemetry-md-current-event-set

Conversation

@noahho
Copy link
Copy Markdown
Collaborator

@noahho noahho commented Apr 23, 2026

Summary

  • Adds three events that the telemetry layer emits today but were missing from the document: model_load, dataset, and extension_entry.
  • Adds the per-event metadata fields that weren't listed: runtime_kernel, runtime_environment, platform_os.
  • Fixes the numpy_vesionnumpy_version typo.
  • Breaks out an "Extra metadata (per-event)" section so readers can see exactly which fields are attached to each event type.

Brings TELEMETRY.md into line with the events declared in tabpfn_common_utils.telemetry.core.events.

Test plan

  • Render on GitHub and eyeball the formatting
  • Confirm event names match tabpfn_common_utils/src/tabpfn_common_utils/telemetry/core/events.py

The event list in TELEMETRY.md was missing three events that the
telemetry layer actually emits: model_load, dataset, and
extension_entry. A handful of per-event metadata fields were also
not documented (runtime_kernel, runtime_environment, platform_os),
and there was a numpy_version typo.

This patch brings the document in line with the events declared in
tabpfn_common_utils.telemetry.core.events, and adds a per-event
breakdown of extra metadata so users can see exactly which fields
are attached to each event type.

No behavioural change.
Copilot AI review requested due to automatic review settings April 23, 2026 19:35
@noahho noahho requested a review from a team as a code owner April 23, 2026 19:35
@noahho noahho requested review from priorjulien and removed request for a team April 23, 2026 19:35
@chatgpt-codex-connector
Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the TELEMETRY.md file to provide a more comprehensive and accurate description of the data collected by the project. It introduces several new events (model_load, dataset, extension_entry), expands the metadata collected for all events (e.g., OS, runtime environment, library versions), and restructures the per-event metadata section. A review comment suggests including the fit_mode parameter in the metadata description for the session event to ensure full transparency.

Comment thread TELEMETRY.md
- `install_id` – unique, random and anonymous installation ID

### Extra metadata (per-event)
- `fit_called` / `predict_called`: `task` (classification or regression), `num_rows` (*rounded*), `num_columns` (*rounded*), `duration_ms`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The session event also appears to collect the fit_mode parameter, as seen in the initialization of TabPFNClassifier and TabPFNRegressor (e.g., log_model_init_params(self, {"fit_mode": self.fit_mode})). It should be included in the "Extra metadata (per-event)" section for completeness and transparency.

Suggested change
- `fit_called` / `predict_called`: `task` (classification or regression), `num_rows` (*rounded*), `num_columns` (*rounded*), `duration_ms`
- `session`: `fit_mode`\n- `fit_called` / `predict_called`: `task` (classification or regression), `num_rows` (*rounded*), `num_columns` (*rounded*), `duration_ms`

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository’s telemetry documentation to reflect the currently emitted event set and associated metadata, aligning TELEMETRY.md with the telemetry layer’s present behavior.

Changes:

  • Expands the documented telemetry events to include model_load, dataset, and extension_entry, and clarifies existing event descriptions.
  • Updates the “Metadata (all events)” list to include additional fields and fixes the numpy_vesionnumpy_version typo.
  • Reorganizes event-specific fields into an “Extra metadata (per-event)” section for clarity.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@noahho noahho merged commit b24c02f into main Apr 23, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants