Skip to content

Say "view" instead of "dashboard" in the panel tools; keep the old names working - #33

Merged
dsblank merged 1 commit into
mainfrom
dsb/view-not-dashboard
Oct 29, 2026
Merged

dsblank merged 1 commit into
mainfrom
dsb/view-not-dashboard

Conversation

@dsblank

@dsblank dsblank commented Oct 29, 2026

Copy link
Copy Markdown
Collaborator

Comet calls a project's saved layouts views, and so do comet_ml's names (View, get_views, create_view). The panel tools and docs now use the same word. Everything released under the old names keeps working.

What changed

Before (still works) Now
cometx panel-upload ... --dashboard NAME --view NAME (--dashboard is still accepted, just hidden from --help)
cometx panel-download ... --dashboard NAME --view NAME
panel_studio.upload_to_dashboard upload_to_view
panel_studio.dashboard_panel_code view_panel_code
panel_studio.dashboard_url view_url
panel_studio.DASHBOARD_PAGE_SIZE EXPERIMENTS_PAGE_SIZE
API.create_dashboard / API.update_dashboard still run, plus a DeprecationWarning pointing to create_view / update_view
  • create_dashboard/update_dashboard are deprecated rather than renamed. Panels passed to create_dashboard don't appear on the view, and update_dashboard's endpoint returns 404 with an API key. Their doc sections are replaced by a short "use this instead" table.
  • The studio's Upload dialog now says "View" and "New view".
  • README-panel-and-dashboard-enhancements.md is now README-panels-and-views.md. The old file stays as a one-line link, so existing links still work.
  • examples/02_build_project_dashboard.py is now 02_build_project_view.py.
  • cometx/views.py docs match comet_ml's copy again (comet-ml/comet-python-client#2769 made the same change).
  • Server names are unchanged: dashboardChartState, DASHBOARD_TOGGLE, isVisibleOnDashboard, dashboard_template, and the dashboard-templates endpoints.
  • The admin and optimizer "dashboard" wording is about other things and isn't touched.

Testing

  • Unit tests: 504 pass. New tests cover:
    • --dashboard still parses into the view on both commands, and is hidden from help.
    • The old panel_studio names still work, including the dashboard= keyword.
    • create_dashboard/update_dashboard warn and still send the same request.
  • Live on comet.com: cometx panel-download --view default and --dashboard default on dsblank/mnist-001 download the same panel code. An unknown view lists the available views.

🤖 Generated with Claude Code

Comet calls a project's saved layouts views, as comet_ml's names (View,
get_views, create_view) do. The panel tools now use the same word:

- cometx panel-upload / panel-download take --view; --dashboard still works
  but is no longer listed in --help.
- cometx.panel_studio has view_url, upload_to_view, view_panel_code and
  EXPERIMENTS_PAGE_SIZE. The 3.6.12 names (dashboard_url, upload_to_dashboard,
  dashboard_panel_code, DASHBOARD_PAGE_SIZE) remain and call the new ones.
- API.create_dashboard and API.update_dashboard still work, but now raise a
  DeprecationWarning pointing to create_view / update_view: panels passed to
  create_dashboard don't appear on the view, and update_dashboard's endpoint
  answers 404 with an API key.
- The panel studio's upload dialog says "View" and "New view".
- README-panel-and-dashboard-enhancements.md is now README-panels-and-views.md;
  the old file links to it. examples/02_build_project_dashboard.py is now
  02_build_project_view.py.

Server field names such as dashboardChartState are unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@baz-reviewer

baz-reviewer Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Review this PR on Baz

Baz Summary

Standardize project panel tooling and documentation on “views” while preserving legacy dashboard names and CLI options. Update panel_studio, CLI commands, API, examples, and documentation, and add deprecation warnings and compatibility tests for the old interfaces.

graph LR
panel_upload_("panel_upload"):::modified
upload_to_view_("upload_to_view"):::added
put_panel_in_layout_("put_panel_in_layout"):::modified
API_create_view_("API.create_view"):::modified
API_update_dashboard_("API.update_dashboard"):::modified
panel_download_("panel_download"):::modified
view_panel_code_("view_panel_code"):::added
find_view_("_find_view"):::added
build_("build"):::modified
build_view_("build_view"):::modified
main_("main"):::modified
panel_upload_ -- "Uploads source code to a named view, creating it when needed." --> upload_to_view_
upload_to_view_ -- "Replaces matching panels or adds new ones without altering other layout content." --> put_panel_in_layout_
upload_to_view_ -- "Creates a project view containing the uploaded panel in Panel Studio." --> API_create_view_
upload_to_view_ -- "Persists updated view layout and panel source through the view update path." --> API_update_dashboard_
panel_download_ -- "Downloads Python panel name and source from a selected project view." --> view_panel_code_
view_panel_code_ -- "Resolves the named view and reports available views when missing." --> find_view_
build_ -- "Builds a named project view with sections, panels, filters, and settings." --> build_view_
main_ -- "Persists the constructed project view, replacing same-name views on reruns." --> API_create_view_
classDef added stroke:#15AA7A
classDef removed stroke:#CD5270
classDef modified stroke:#EDAC4C
linkStyle default stroke:#CBD5E1,font-size:13px
Loading

Topics

TopicDetails
View API Migration Deprecate create_dashboard and update_dashboard with DeprecationWarning while retaining their existing requests, clarify that panel associations do not populate view layouts, and align view builder documentation and examples with Comet’s terminology.
Modified files (13)
  • README-panel-and-dashboard-enhancements.md
  • README-panels-and-views.md
  • cometx/api.py
  • cometx/views.py
  • examples/00_seed_demo_project.py
  • examples/01_inspect_views.py
  • examples/02_build_project_view.py
  • examples/04_migrate_views.py
  • examples/05_standardize_workspace.py
  • examples/06_harvest_panels.py
  • examples/07_code_panels.py
  • examples/README.md
  • tests/unit/test_api_views.py
Latest Contributors(2)
UserCommitDate
doug@comet.comSay "view" instead of ...October 29, 2026
doug.blank@gmail.comUpdate panel/dashboard...October 29, 2026
Panel View Workflow Rename panel upload, download, studio, and preview terminology and APIs from dashboards to views, including --view, upload_to_view, view_panel_code, view_url, and EXPERIMENTS_PAGE_SIZE. Keep legacy helpers and hidden --dashboard options functional.
Modified files (10)
  • PANEL-STUDIO.md
  • README.md
  • cometx/cli/panel_download.py
  • cometx/cli/panel_preview.py
  • cometx/cli/panel_studio.py
  • cometx/cli/panel_studio_app.py
  • cometx/cli/panel_upload.py
  • cometx/panel_studio.py
  • tests/unit/test_panel_files.py
  • tests/unit/test_panel_studio.py
Latest Contributors(2)
UserCommitDate
doug@comet.comSay "view" instead of ...October 29, 2026
doug.blank@gmail.comPanel studio: follow a...October 28, 2026


Merger  Activate to get a short verdict whether this PR is good to go or not

Skills  Activate Skill Maintainer to keep your skills up to date

Planner  This PR would have been improved with Baz Planner - Try it now

@dsblank
dsblank merged commit 8ab3dd8 into main Oct 29, 2026
2 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.

1 participant