Skip to content

Remove obsolete Comet integration - #775

Draft
lanpa wants to merge 2 commits into
masterfrom
remove-comet-integration
Draft

lanpa wants to merge 2 commits into
masterfrom
remove-comet-integration

Conversation

@lanpa

@lanpa lanpa commented Jul 7, 2026

Copy link
Copy Markdown
Owner

Description

Removes the Comet.ml logging integration (added in #625, follow-ups #639/#658), continuing the cleanup of obsolete integrations (visdom in #768, TorchVis in #772).

Changes

  • Delete tensorboardX/comet_utils.py (CometLogger, 387 lines)
  • Delete examples/demo_comet.py and screenshots/comet.gif
  • tensorboardX/writer.py:
    • Remove the comet_config constructor parameter and its docstring
    • Remove _get_comet_logger() and the _comet_config/_comet_logger attributes
    • Remove the self._get_comet_logger().log_*() call at the end of all 17 add_* methods and the .end() call in close()
    • Remove the four encoded_image_string assignments that existed only to feed Comet
  • Remove the "Using TensorboardX with Comet" section from README.md
  • HISTORY.rst mentions are kept as historical release notes

Breaking change

SummaryWriter(comet_config=...) now raises TypeError (consistent with the visdom/TorchVis removals). Related open issues #723 and #639 can be closed as obsolete once this merges.

Verification

  • Full test suite: 94 passed
  • ruff check tensorboardX: clean
  • mypy tensorboardX: no issues in 13 source files

🤖 Generated with Claude Code

Remove the Comet.ml logging integration added in #625: the CometLogger
class, the comet_config parameter of SummaryWriter, the per-method
log_* forwarding calls, the demo example, and the README section.
Historical release notes in HISTORY.rst are kept.

Note: SummaryWriter(comet_config=...) now raises TypeError.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@codecov

codecov Bot commented Jul 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.31%. Comparing base (48a5f8a) to head (77f9ce7).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #775      +/-   ##
==========================================
+ Coverage   87.83%   91.31%   +3.47%     
==========================================
  Files          29       28       -1     
  Lines        1694     1532     -162     
==========================================
- Hits         1488     1399      -89     
+ Misses        206      133      -73     
Flag Coverage Δ
service 91.31% <ø> (+3.47%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
tensorboardX/writer.py 88.92% <ø> (-0.77%) ⬇️

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This pull request removes the obsolete Comet.ml integration from TensorboardX, continuing the project’s cleanup of unmaintained third-party integrations while keeping historical release notes intact.

Changes:

  • Removes Comet integration plumbing from SummaryWriter (constructor arg, logger lifecycle, and all add_* Comet logging calls).
  • Deletes Comet-specific module and demo assets (Comet utility module + example).
  • Removes the Comet usage section from the README and adds a regression test ensuring comet_config is rejected.

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tensorboardX/writer.py Removes Comet integration hooks and rejects comet_config in kwargs.
tensorboardX/comet_utils.py Deletes the Comet logger implementation (entire module).
examples/demo_comet.py Deletes Comet demo script that depended on the integration.
README.md Removes Comet usage documentation section and associated screenshot reference.
tests/test_summary_writer.py Adds a test asserting comet_config now raises TypeError.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread tensorboardX/writer.py
Comment on lines +315 to 321
if "comet_config" in kwargs:
raise TypeError(
"SummaryWriter.__init__() got an unexpected keyword argument 'comet_config'"
)
if log_dir is not None and logdir is None:
logdir = log_dir
if not logdir:
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