Repository navigation
Update panel/dashboard README and examples; view safeguards in API - #32
Merged
Merged
Conversation
README-panel-and-dashboard-enhancements.md: - create_dashboard(panels=[...]) associates library panels but doesn't put them on the dashboard (it opens empty); say so, and show python_panel(code=...) in a view as the way to place Python code. - Replace the create_view gotcha (comet.com refuses duplicate names) and the private _client.upsert_view advice with update_view. - Document option values, global_config overrides, experiment view name uniqueness, the library getters, and API(cache=False) for read-modify-write code; merge the duplicate bar_panel rows. - Rewrite the Typical Workflow, which relied on create_dashboard placing panels. examples/: the fixed versions from comet-python-client's examples/panels_and_views, using cometx.views and cometx's API: 03 drops --all and updates in place, 04 is safe to rerun, 05 uses update_view, 06 harvests inline Python and JavaScript panels, the log-scale charts are locked, and 07_code_panels.py is new. cometx.API, the same on any comet_ml version: - create_view raises ValueError for a name already in use. - create_view/update_view and the new create_experiment_view / update_experiment_view reject a layout built for the other scope, which would save but show no panels. - update_experiment_view replaces an experiment view in place, using comet_ml's own where available. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
| Topic | Details | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| View API safeguards | Harden project and experiment view lifecycle operations by validating layout scope, providing actionable duplicate-name errors, and adding compatible in-place experiment updates through update_experiment_view.Modified files (2)
Latest Contributors(2)
| |||||||||
| Dashboard examples | Modernize dashboard and panel workflows by documenting layout and library-panel limitations, adding code-panel examples, making scripts rerunnable with updates, and correcting stale or broken example behavior.Modified files (10)
Latest Contributors(2)
|
When an experiment view's name and its "NAME (SOURCE-PROJECT)" rename are both used in other projects, the view is reported as skipped and the migration continues with the remaining views. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
README-panel-and-dashboard-enhancements.mdandexamples/predated what we learned while building and live-testing the panel tools:create_dashboard(panels=[...])doesn't place panels. It stores the library panels' association, but the dashboard opens empty: placing a library panel needs a panel instance, which only the Comet UI creates. The README's Typical Workflow relied on it.create_viewdoesn't make duplicates on comet.com; it refuses the name. The README said it adds a second view, and recommended the privateapi._client.upsert_view.--allalways fails after the first run (experiment view names are unique across projects), 05 used_client.upsert_view, 06 missed inline Python and JavaScript panels, and the log-scale charts in 02/03 drew linear axes becauseglobal_configoverrode them.What
README (
README-panel-and-dashboard-enhancements.md):create_dashboard/update_dashboard: a note that associating panels doesn't lay them out; the way to place Python code ispython_panel(code=...)in a view.get_panels,get_panel,get_panel_code,download_panel_zip.transform_y,outliers, aggregations, barplot_type,group_by_aggregation); merged the duplicatebar_panelrows; fullerglobal_config/lockednote.update_viewfor in-place updates, experiment view name uniqueness, the builder/scope check, andAPI(cache=False)for read-modify-write code.Examples: the fixed versions from comet-python-client's
examples/panels_and_views, ported tocometx.viewsand cometx'sAPI, plus07_code_panels.py.examples/README.mdupdated to match.cometx.API, the same on any comet_ml version:create_viewraises aValueErrorfor a name already in use, pointing toupdate_view.create_view/update_viewand the newcreate_experiment_view/update_experiment_viewreject a layout built for the other scope, which Comet would save but show with no panels.update_experiment_viewreplaces an experiment view in place (released comet_ml 3.58.8 has noAPIExperiment.update_view).Testing
tests/unit/test_api_views.py.🤖 Generated with Claude Code