Skip to content

feat(experiments): Remove experiment summary field, description field remains#507

Merged
shanaiabuggy merged 5 commits into
mainfrom
sbuggy/experiment-description
Jun 29, 2026
Merged

feat(experiments): Remove experiment summary field, description field remains#507
shanaiabuggy merged 5 commits into
mainfrom
sbuggy/experiment-description

Conversation

@shanaiabuggy

@shanaiabuggy shanaiabuggy commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

We had both description and summary fields on the Experiment entity. This was a redundant oversight. Reducing to just description. Summary was previously surfaced in the UI (description was not), swapped this out to surface description in the UI.

Summary by CodeRabbit

  • New Features

    • Experiment details and lists now show a description field instead of summary (including tooltips and page header context when available).
  • Bug Fixes

    • Updated experiment create/edit flows to persist and return the correct text field consistently.
    • Demo experiment data and related screens now use the same description-based wording.
    • Experiment update behavior and API responses were aligned so the displayed text matches what was entered.
    • Updated integration coverage to validate description updates.

@shanaiabuggy
shanaiabuggy requested review from a team as code owners June 29, 2026 18:56
@github-actions github-actions Bot added the feat label Jun 29, 2026
@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 9ee87edd-64a5-4cb3-be55-4cdfba6dfc7a

📥 Commits

Reviewing files that changed from the base of the PR and between 4eb9f6c and a74eacf.

⛔ Files ignored due to path filters (6)
  • sdk/python/nemo-platform/src/nemo_platform/types/guardrail/log_adapter_config_param.py is excluded by !sdk/**
  • sdk/python/nemo-platform/src/nemo_platform/types/guardrail/model_parameters_param.py is excluded by !sdk/**
  • sdk/python/nemo-platform/src/nemo_platform/types/intake/ingest/captured_chat_completions_request_param.py is excluded by !sdk/**
  • sdk/python/nemo-platform/src/nemo_platform/types/intake/ingest/captured_chat_completions_response_param.py is excluded by !sdk/**
  • sdk/python/nemo-platform/src/nemo_platform/types/intake/ingest/captured_chat_message_param.py is excluded by !sdk/**
  • sdk/python/nemo-platform/src/nemo_platform/types/shared_params/inference_params.py is excluded by !sdk/**
📒 Files selected for processing (1)
  • web/packages/studio/src/components/dataViews/ExperimentGroupDataView/index.tsx
🚧 Files skipped from review as they are similar to previous changes (1)
  • web/packages/studio/src/components/dataViews/ExperimentGroupDataView/index.tsx

📝 Walkthrough

Walkthrough

Replaces the experiment summary field with description across the API contract, backend entity and endpoint mapping, demo seed data, tests, and studio UI.

Changes

summary → description rename

Layer / File(s) Summary
Contract and model fields
services/intake/src/nmp/intake/api/v2/experiments/schemas.py, services/intake/src/nmp/intake/entities/experiments.py, openapi/openapi.yaml, openapi/ga/openapi.yaml, openapi/ga/individual/platform.openapi.yaml
summary is removed from experiment request/response models and entity shape; description is exposed in the updated schemas.
Endpoint mapping
services/intake/src/nmp/intake/api/v2/experiments/endpoints.py
Experiment create/update no longer maps summary; the mutable-field comment is updated.
Demo seeding
services/intake/scripts/spans/seed_experiments_demo.py
ExperimentSpec.summary is removed; demo experiment entries and request body assembly stop using summary.
Client usage updates
services/intake/tests/integration/test_experiments_crud.py, web/packages/studio/src/components/dataViews/ExperimentGroupDataView/index.tsx, web/packages/studio/src/routes/ExperimentDetailRoute/index.tsx
The CRUD test, experiment list tooltip, and detail header all switch to description.

Possibly related PRs

Suggested reviewers

  • nakolean
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: removing the experiment summary field while keeping description.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch sbuggy/experiment-description

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 21929/28733 76.3% 61.0%
Integration Tests 12583/27413 45.9% 19.2%

Signed-off-by: shanaiabuggy <[email protected]>
Signed-off-by: shanaiabuggy <[email protected]>
@shanaiabuggy
shanaiabuggy enabled auto-merge June 29, 2026 22:08
@shanaiabuggy
shanaiabuggy added this pull request to the merge queue Jun 29, 2026
Merged via the queue into main with commit 40df17d Jun 29, 2026
54 checks passed
@shanaiabuggy
shanaiabuggy deleted the sbuggy/experiment-description branch June 29, 2026 22:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants